Skip to content

Commit 0b73f22

Browse files
authored
Merge pull request #4 from rust-lang/readme-update
Update README.md
2 parents 24aa1f4 + 639e2d2 commit 0b73f22

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,19 @@
22

33
Code repository for the [Portable SIMD Project Group](https://github.com/rust-lang/project-portable-simd).
44

5-
More coming soon!
5+
## Code Organization
6+
7+
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.
8+
9+
All types are then exported as a single, flat module.
10+
11+
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.
12+
13+
The supported element types are as follows:
14+
* **Floating Point:** `f32`, `f64`
15+
* **Signed Integers:** `i8`, `i16`, `i32`, `i64`, `i128`, `isize`
16+
* **Unsigned Integers:** `u8`, `u16`, `u32`, `u64`, `u128`, `usize`
17+
* **Masks:** `mask8`, `mask16`, `mask32`, `mask64`, `masksize`
18+
19+
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.
20+
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.

0 commit comments

Comments
 (0)