rust-lang / rust-lang/portable-simd

Add pretty pictures to the beginners guide

Open
#74 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-feature-request
Dominant language
Rust
Stars
1.1k
Forks
108
Avg merge
22h 53m
Merged PRs (30d)
3

Description

Add pictures in the spirit of https://cheats.rs/#numeric-types-ref
"These are 128 bits of memory. They represent 4 different floats of 32 bits. If we put them in a SIMD vector, the vector width is 128 bits, and the lane size is 32 bits, with 4 lanes."

"Lane sizes can vary on instruction, and so can vector widths. This is a vectorwidth of 512, but with int64s in the available 8 lanes. If they were int8s, We could have 64 lanes of them. Rust allows at a minimum a lane size of 8."

"These operations work on lanes vertically - ie, from one SIMD vector on another SIMD vector of the same vector size."

cc @workingjubilee

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the beginners guide and review the cheats.rs numeric-types-ref section for visual direction. Create explanatory pictures for the SIMD vector, lane size, vector width, and vertical lane operations described in the issue, then verify that the guide renders them correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.