README.md

   1 # stdsimd - Rust's standard library portable SIMD API
   2 [![Build Status](https://travis-ci.com/rust-lang/stdsimd.svg?branch=master)](https://travis-ci.com/rust-lang/stdsimd)
   3
   4 Code repository for the [Portable SIMD Project Group](https://github.com/rust-lang/project-portable-simd).
   5 Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) for our contributing guidelines.
   6
   7 If you have questions about SIMD, we have begun writing a [guide][simd-guide].
   8 We can also be found on [Zulip][zulip-project-portable-simd].
   9
  10 If you are interested in support for a specific architecture, you may want [stdarch] instead.
  11
  12 ## Code Organization
  13
  14 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.
  15
  16 All types are then exported as a single, flat module.
  17
  18 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.
  19
  20 The supported element types are as follows:
  21 * **Floating Point:** `f32`, `f64`
  22 * **Signed Integers:** `i8`, `i16`, `i32`, `i64`, `i128`, `isize`
  23 * **Unsigned Integers:** `u8`, `u16`, `u32`, `u64`, `u128`, `usize`
  24 * **Masks:** `mask8`, `mask16`, `mask32`, `mask64`, `mask128`, `masksize`
  25
  26 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.
  27 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.
  28
  29 [simd-guide]: ./beginners-guide.md
  30 [zulip-project-portable-simd]: https://rust-lang.zulipchat.com/#narrow/stream/257879-project-portable-simd
  31 [stdarch]: https://github.com/rust-lang/stdarch