Skip to content

Add some missing docs for Vector64/128/256/512 #11635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 3, 2025
+30 −30
Merged

Add some missing docs for Vector64/128/256/512 #11635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
332dd7e
update Min and Max remarks
gewarren Aug 2, 2025
77c0955
add docs for Clamp
gewarren Aug 2, 2025
bf167ee
syntax
gewarren Aug 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions xml/System.Runtime.Intrinsics/Vector128.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1872,7 +1872,7 @@
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<typeparam name="T">The type of the elements in the vector.</typeparam>
<param name="value">The vector to restrict.</param>
<param name="min">The minimum value.</param>
<param name="max">The maximum value.</param>
Expand Down Expand Up @@ -8258,7 +8258,7 @@ This method may bypass the cache on certain platforms.
<param name="right">The vector to compare with <paramref name="left" />.</param>
<summary>Computes the maximum of two vectors on a per-element basis.</summary>
<returns>A vector whose elements are the maximum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
<remarks>For <see cref="T:System.Numerics.IFloatingPoint`1" /> this method matches the IEEE 754:2019 <c>maximum</c> function.This requires NaN inputs to be propagated back to the caller and for <c>-0.0</c> to be treated as less than <c>+0.0</c>.</remarks>
<remarks>For <see cref="T:System.Numerics.IFloatingPoint`1" />, this method matches the IEEE 754:2019 <c>maximum</c> function. This requires NaN inputs to be propagated back to the caller and for <c>-0.0</c> to be treated as less than <c>+0.0</c>.</remarks>
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -8530,7 +8530,7 @@ This method may bypass the cache on certain platforms.
<param name="right">The vector to compare with <paramref name="left" />.</param>
<summary>Computes the minimum of two vectors on a per-element basis.</summary>
<returns>A vector whose elements are the minimum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
<remarks>For <see cref="T:System.Numerics.IFloatingPoint`1" /> this method matches the IEEE 754:2019 <c>minimum</c> function.This requires NaN inputs to be propagated back to the caller and for <c>-0.0</c> to be treated as less than <c>+0.0</c>.</remarks>
<remarks>For <see cref="T:System.Numerics.IFloatingPoint`1" />, this method matches the IEEE 754:2019 <c>minimum</c> function. This requires NaN inputs to be propagated back to the caller and for <c>-0.0</c> to be treated as less than <c>+0.0</c>.</remarks>
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
</Docs>
</Member>
Expand Down
18 changes: 9 additions & 9 deletions xml/System.Runtime.Intrinsics/Vector256.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1533,14 +1533,14 @@
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="value">To be added.</param>
<param name="min">To be added.</param>
<param name="max">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">The type of the elements in the vector.</typeparam>
<param name="value">The vector to restrict.</param>
<param name="min">The minimum value.</param>
<param name="max">The maximum value.</param>
<summary>Restricts a vector between a minimum and a maximum value.</summary>
<returns>The restricted vector.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Clamp``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
<exception cref="T:System.NotSupportedException">The type of the elements in the vector (<typeparamref name="T" />) is not supported.</exception>
</Docs>
</Member>
<Member MemberName="ClampNative&lt;T&gt;">
Expand Down Expand Up @@ -8117,7 +8117,7 @@ This method may bypass the cache on certain platforms.
<param name="right">The vector to compare with <paramref name="left" />.</param>
<summary>Computes the maximum of two vectors on a per-element basis.</summary>
<returns>A vector whose elements are the maximum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
<remarks>To be added.</remarks>
<remarks>For <see cref="T:System.Numerics.IFloatingPoint`1" />, this method matches the IEEE 754:2019 <c>maximum</c> function. This requires NaN inputs to be propagated back to the caller and for <c>-0.0</c> to be treated as less than <c>+0.0</c>.</remarks>
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Max``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
Expand Down Expand Up @@ -8390,7 +8390,7 @@ This method may bypass the cache on certain platforms.
<param name="right">The vector to compare with <paramref name="left" />.</param>
<summary>Computes the minimum of two vectors on a per-element basis.</summary>
<returns>A vector whose elements are the minimum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
<remarks>To be added.</remarks>
<remarks>For <see cref="T:System.Numerics.IFloatingPoint`1" />, this method matches the IEEE 754:2019 <c>minimum</c> function. This requires NaN inputs to be propagated back to the caller and for <c>-0.0</c> to be treated as less than <c>+0.0</c>.</remarks>
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Min``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
Expand Down
18 changes: 9 additions & 9 deletions xml/System.Runtime.Intrinsics/Vector512.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
<param name="vector">The vector that will have its absolute value computed.</param>
<summary>Computes the absolute value of each element in a vector.</summary>
<returns>A vector whose elements are the absolute value of the elements in <paramref name="vector" />.</returns>
<remarks>To be added.</remarks>
<remarks>For <see cref="T:System.Numerics.IFloatingPoint`1" />, this method matches the IEEE 754:2019 <c>maximum</c> function. This requires NaN inputs to be propagated back to the caller and for <c>-0.0</c> to be treated as less than <c>+0.0</c>.</remarks>
<exception cref="T:System.NotSupportedException">The type of <paramref name="vector" /> (<typeparamref name="T" />) is not supported.</exception>
</Docs>
</Member>
Expand Down Expand Up @@ -1336,14 +1336,14 @@
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="value">To be added.</param>
<param name="min">To be added.</param>
<param name="max">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">The type of the elements in the vector.</typeparam>
<param name="value">The vector to restrict.</param>
<param name="min">The minimum value.</param>
<param name="max">The maximum value.</param>
<summary>Restricts a vector between a minimum and a maximum value.</summary>
<returns>The restricted vector.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Clamp``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
<exception cref="T:System.NotSupportedException">The type of the elements in the vector (<typeparamref name="T" />) is not supported.</exception>
</Docs>
</Member>
<Member MemberName="ClampNative&lt;T&gt;">
Expand Down Expand Up @@ -7801,7 +7801,7 @@
<param name="right">The vector to compare with <paramref name="left" />.</param>
<summary>Computes the minimum of two vectors on a per-element basis.</summary>
<returns>A vector whose elements are the minimum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
<remarks>To be added.</remarks>
<remarks>For <see cref="T:System.Numerics.IFloatingPoint`1" />, this method matches the IEEE 754:2019 <c>minimum</c> function. This requires NaN inputs to be propagated back to the caller and for <c>-0.0</c> to be treated as less than <c>+0.0</c>.</remarks>
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Min``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
Expand Down
18 changes: 9 additions & 9 deletions xml/System.Runtime.Intrinsics/Vector64.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1425,14 +1425,14 @@
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="value">To be added.</param>
<param name="min">To be added.</param>
<param name="max">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">The type of the elements in the vector.</typeparam>
<param name="value">The vector to restrict.</param>
<param name="min">The minimum value.</param>
<param name="max">The maximum value.</param>
<summary>Restricts a vector between a minimum and a maximum value.</summary>
<returns>The restricted vector.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Clamp``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
<exception cref="T:System.NotSupportedException">The type of the elements in the vector (<typeparamref name="T" />) is not supported.</exception>
</Docs>
</Member>
<Member MemberName="ClampNative&lt;T&gt;">
Expand Down Expand Up @@ -6901,7 +6901,7 @@ This method may bypass the cache on certain platforms.
<param name="right">The vector to compare with <paramref name="left" />.</param>
<summary>Computes the maximum of two vectors on a per-element basis.</summary>
<returns>A vector whose elements are the maximum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
<remarks>To be added.</remarks>
<remarks>For <see cref="T:System.Numerics.IFloatingPoint`1" />, this method matches the IEEE 754:2019 <c>maximum</c> function. This requires NaN inputs to be propagated back to the caller and for <c>-0.0</c> to be treated as less than <c>+0.0</c>.</remarks>
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Max``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
Expand Down Expand Up @@ -7174,7 +7174,7 @@ This method may bypass the cache on certain platforms.
<param name="right">The vector to compare with <paramref name="left" />.</param>
<summary>Computes the minimum of two vectors on a per-element basis.</summary>
<returns>A vector whose elements are the minimum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
<remarks>To be added.</remarks>
<remarks>For <see cref="T:System.Numerics.IFloatingPoint`1" />, this method matches the IEEE 754:2019 <c>minimum</c> function. This requires NaN inputs to be propagated back to the caller and for <c>-0.0</c> to be treated as less than <c>+0.0</c>.</remarks>
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Min``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
Expand Down