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 The docs for this crate are published from the main branch.
   8 You can [read them here][docs].
   9
  10 If you have questions about SIMD, we have begun writing a [guide][simd-guide].
  11 We can also be found on [Zulip][zulip-project-portable-simd].
  12
  13 If you are interested in support for a specific architecture, you may want [stdarch] instead.
  14
  15 ## Code Organization
  16
  17 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.
  18
  19 All types are then exported as a single, flat module.
  20
  21 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.
  22
  23 The supported element types are as follows:
  24 * **Floating Point:** `f32`, `f64`
  25 * **Signed Integers:** `i8`, `i16`, `i32`, `i64`, `i128`, `isize`
  26 * **Unsigned Integers:** `u8`, `u16`, `u32`, `u64`, `u128`, `usize`
  27 * **Masks:** `mask8`, `mask16`, `mask32`, `mask64`, `mask128`, `masksize`
  28
  29 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.
  30 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.
  31
  32 [simd-guide]: ./beginners-guide.md
  33 [zulip-project-portable-simd]: https://rust-lang.zulipchat.com/#narrow/stream/257879-project-portable-simd
  34 [stdarch]: https://github.com/rust-lang/stdarch
  35 [docs]: https://rust-lang.github.io/stdsimd/core_simd