1 # The Rust standard library's portable SIMD API
2 [![Build Status](https://travis-ci.com/rust-lang/portable-simd.svg?branch=master)](https://travis-ci.com/rust-lang/portable-simd)
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.
7 The docs for this crate are published from the main branch.
8 You can [read them here][docs].
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].
13 If you are interested in support for a specific architecture, you may want [stdarch] instead.
17 Now we're gonna dip our toes into this world with a small SIMD "Hello, World!" example. Make sure your compiler is up to date and using `nightly`. We can do that by running
20 rustup update -- nightly
23 or by setting up `rustup default nightly` or else with `cargo +nightly {build,test,run}`. After updating, run
27 to create a new crate. Edit `hellosimd/Cargo.toml` to be
34 core_simd = { git = "https://github.com/rust-lang/portable-simd" }
37 and finally write this in `src/main.rs`:
41 let a = f32x4::splat(10.0);
42 let b = f32x4::from_array([1.0, 2.0, 3.0, 4.0]);
43 println!("{:?}", a + b);
47 Explanation: We import all the bindings from the crate with the first line. Then, we construct our SIMD vectors with methods like `splat` or `from_array`. Finally, we can use operators on them like `+` and the appropriate SIMD instructions will be carried out. When we run `cargo run` you should get `[11.0, 12.0, 13.0, 14.0]`.
51 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.
53 All types are then exported as a single, flat module.
55 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.
57 The supported element types are as follows:
58 * **Floating Point:** `f32`, `f64`
59 * **Signed Integers:** `i8`, `i16`, `i32`, `i64`, `i128`, `isize`
60 * **Unsigned Integers:** `u8`, `u16`, `u32`, `u64`, `u128`, `usize`
61 * **Masks:** `mask8`, `mask16`, `mask32`, `mask64`, `mask128`, `masksize`
63 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.
64 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.
66 [simd-guide]: ./beginners-guide.md
67 [zulip-project-portable-simd]: https://rust-lang.zulipchat.com/#narrow/stream/257879-project-portable-simd
68 [stdarch]: https://github.com/rust-lang/stdarch
69 [docs]: https://rust-lang.github.io/portable-simd/core_simd