Documentation for intrinsics does not document what each method does.

[cjudge-costarGroup]

Type of issue

Missing information

Description

Documentation for the intrinsics does not document what each method does.

Example: Sse2.Shuffle:

• What, exactly, does it do?
• How does it use the left, right, and control parameters?
• Does it shuffle randomly like shuffling a deck of cards, does it move the values inside the vector like a shift or a rotate op with the control parameter controlling how "far" to shift or rotate?
• Why are there two input vectors (left and right)?
• Are the inputs altered by the shuffling?

The documentation (https://learn.microsoft.com/en-us/dotnet/api/system.runtime.intrinsics.x86.sse2.shuffle?view=net-10.0) answers none of these questions.

Page URL

https://learn.microsoft.com/en-us/dotnet/api/system.runtime.intrinsics.x86.ssse3.shuffle?view=net-10.0#system-runtime-intrinsics-x86-ssse3-shuffle(system-runtime-intrinsics-vector128((system-byte))-system-runtime-intrinsics-vector128((system-byte)))

Content source URL

https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Runtime.Intrinsics.X86/Ssse3.xml

Document Version Independent Id

be4b31a8-ce89-e04a-5152-56f0ba03fc87

Platform Id

669f61d3-efe4-76c5-69a6-8e27e635b6e4

Article author

@dotnet-bot

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/area-system-runtime