Skip to content

Commit aad8f0a

Browse files
Merge pull request rust-lang#310 from rust-lang/readme
Update readme
2 parents 2f38f70 + f236f57 commit aad8f0a

File tree

1 file changed

+9
-21
lines changed

1 file changed

+9
-21
lines changed

README.md

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,45 +24,33 @@ or by setting up `rustup default nightly` or else with `cargo +nightly {build,te
2424
```bash
2525
cargo new hellosimd
2626
```
27-
to create a new crate. Edit `hellosimd/Cargo.toml` to be
28-
```toml
29-
[package]
30-
name = "hellosimd"
31-
version = "0.1.0"
32-
edition = "2018"
33-
[dependencies]
34-
core_simd = { git = "https://github.com/rust-lang/portable-simd" }
35-
```
36-
37-
and finally write this in `src/main.rs`:
27+
to create a new crate. Finally write this in `src/main.rs`:
3828
```rust
3929
#![feature(portable_simd)]
40-
use core_simd::*;
30+
use std::simd::f32x4;
4131
fn main() {
4232
let a = f32x4::splat(10.0);
4333
let b = f32x4::from_array([1.0, 2.0, 3.0, 4.0]);
4434
println!("{:?}", a + b);
4535
}
4636
```
4737

48-
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]`.
49-
50-
## Code Organization
38+
Explanation: We construct our SIMD vectors with methods like `splat` or `from_array`. Next, we can use operators like `+` on them, 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]`.
5139

52-
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.
40+
## Supported vectors
5341

54-
All types are then exported as a single, flat module.
42+
Currently, vectors may have up to 64 elements, but aliases are provided only up to 512-bit vectors.
5543

5644
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.
5745

5846
The supported element types are as follows:
5947
* **Floating Point:** `f32`, `f64`
60-
* **Signed Integers:** `i8`, `i16`, `i32`, `i64`, `i128`, `isize`
61-
* **Unsigned Integers:** `u8`, `u16`, `u32`, `u64`, `u128`, `usize`
62-
* **Masks:** `mask8`, `mask16`, `mask32`, `mask64`, `mask128`, `masksize`
48+
* **Signed Integers:** `i8`, `i16`, `i32`, `i64`, `isize` (`i128` excluded)
49+
* **Unsigned Integers:** `u8`, `u16`, `u32`, `u64`, `usize` (`u128` excluded)
50+
* **Masks:** 8-bit, 16-bit, 32-bit, 64-bit, and `usize`-sized masks
6351

6452
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.
65-
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.
53+
The mask types have elements that are "truthy" values, like `bool`, but have an unspecified layout because different architectures prefer different layouts for mask types.
6654

6755
[simd-guide]: ./beginners-guide.md
6856
[zulip-project-portable-simd]: https://rust-lang.zulipchat.com/#narrow/stream/257879-project-portable-simd

0 commit comments

Comments
 (0)