README.md

   1 # stdsimd - Rust's standard library portable SIMD API
   2
   3 [![Build Status](https://travis-ci.com/rust-lang/stdsimd.svg?branch=master)](https://travis-ci.com/rust-lang/stdsimd)
   4
   5 Code repository for the [Portable SIMD Project Group](https://github.com/rust-lang/project-portable-simd).
   6
   7 ## Code Organization
   8
   9 Currently the crate is organized so that each element type is a file, and then the 64-bit, 128-bit, 256-bit, and 512-bit vectors using those types are contained in said file.
  10
  11 All types are then exported as a single, flat module.
  12
  13 Depending on the size of the primitive type, the number of lanes the vector will have varies. For example, 128-bit vectors have four `f32` lanes and two `f64` lanes.
  14
  15 The supported element types are as follows:
  16 * **Floating Point:** `f32`, `f64`
  17 * **Signed Integers:** `i8`, `i16`, `i32`, `i64`, `i128`, `isize`
  18 * **Unsigned Integers:** `u8`, `u16`, `u32`, `u64`, `u128`, `usize`
  19 * **Masks:** `mask8`, `mask16`, `mask32`, `mask64`, `mask128`, `masksize`
  20
  21 Floating point, signed integers, and unsigned integers are the [primitive types](https://doc.rust-lang.org/core/primitive/index.html) you're already used to.
  22 The `mask` types are "truthy" values, but they use the number of bits in their name instead of just 1 bit like a normal `bool` uses.