Skip to content

Commit 3032a62

Browse files
authored
add helloworld to README (rust-lang#134)
* add helloworld to README
1 parent 4311c06 commit 3032a62

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

+34
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,40 @@ We can also be found on [Zulip][zulip-project-portable-simd].
1212

1313
If you are interested in support for a specific architecture, you may want [stdarch] instead.
1414

15+
## Hello World
16+
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
18+
19+
```bash
20+
rustup update -- nightly
21+
```
22+
23+
or by setting up `rustup default nightly` or else with `cargo +nihgtly {build,test, run}`. After updating, run
24+
```bash
25+
cargo new hellosimd
26+
```
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/stdsimd" }
35+
```
36+
37+
and finally write this in `src/main.rs`:
38+
```rust
39+
use core_simd::*;
40+
fn main() {
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);
44+
}
45+
```
46+
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]`.
48+
1549
## Code Organization
1650

1751
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.

0 commit comments

Comments
 (0)