Skip to content

Commit 330c8a7

Browse files
authored
Add some missing docs for Vector64/128/256/512 (#11635)
1 parent 6321b6c commit 330c8a7

File tree

4 files changed

+30
-30
lines changed

4 files changed

+30
-30
lines changed

xml/System.Runtime.Intrinsics/Vector128.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1872,7 +1872,7 @@
18721872
</Parameter>
18731873
</Parameters>
18741874
<Docs>
1875-
<typeparam name="T">To be added.</typeparam>
1875+
<typeparam name="T">The type of the elements in the vector.</typeparam>
18761876
<param name="value">The vector to restrict.</param>
18771877
<param name="min">The minimum value.</param>
18781878
<param name="max">The maximum value.</param>
@@ -8258,7 +8258,7 @@ This method may bypass the cache on certain platforms.
82588258
<param name="right">The vector to compare with <paramref name="left" />.</param>
82598259
<summary>Computes the maximum of two vectors on a per-element basis.</summary>
82608260
<returns>A vector whose elements are the maximum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
8261-
<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>
8261+
<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>
82628262
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
82638263
</Docs>
82648264
</Member>
@@ -8530,7 +8530,7 @@ This method may bypass the cache on certain platforms.
85308530
<param name="right">The vector to compare with <paramref name="left" />.</param>
85318531
<summary>Computes the minimum of two vectors on a per-element basis.</summary>
85328532
<returns>A vector whose elements are the minimum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
8533-
<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>
8533+
<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>
85348534
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
85358535
</Docs>
85368536
</Member>

xml/System.Runtime.Intrinsics/Vector256.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1533,14 +1533,14 @@
15331533
</Parameter>
15341534
</Parameters>
15351535
<Docs>
1536-
<typeparam name="T">To be added.</typeparam>
1537-
<param name="value">To be added.</param>
1538-
<param name="min">To be added.</param>
1539-
<param name="max">To be added.</param>
1540-
<summary>To be added.</summary>
1541-
<returns>To be added.</returns>
1536+
<typeparam name="T">The type of the elements in the vector.</typeparam>
1537+
<param name="value">The vector to restrict.</param>
1538+
<param name="min">The minimum value.</param>
1539+
<param name="max">The maximum value.</param>
1540+
<summary>Restricts a vector between a minimum and a maximum value.</summary>
1541+
<returns>The restricted vector.</returns>
15421542
<remarks>To be added.</remarks>
1543-
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Clamp``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
1543+
<exception cref="T:System.NotSupportedException">The type of the elements in the vector (<typeparamref name="T" />) is not supported.</exception>
15441544
</Docs>
15451545
</Member>
15461546
<Member MemberName="ClampNative&lt;T&gt;">
@@ -8117,7 +8117,7 @@ This method may bypass the cache on certain platforms.
81178117
<param name="right">The vector to compare with <paramref name="left" />.</param>
81188118
<summary>Computes the maximum of two vectors on a per-element basis.</summary>
81198119
<returns>A vector whose elements are the maximum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
8120-
<remarks>To be added.</remarks>
8120+
<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>
81218121
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
81228122
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Max``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
81238123
</Docs>
@@ -8390,7 +8390,7 @@ This method may bypass the cache on certain platforms.
83908390
<param name="right">The vector to compare with <paramref name="left" />.</param>
83918391
<summary>Computes the minimum of two vectors on a per-element basis.</summary>
83928392
<returns>A vector whose elements are the minimum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
8393-
<remarks>To be added.</remarks>
8393+
<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>
83948394
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
83958395
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Min``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
83968396
</Docs>

xml/System.Runtime.Intrinsics/Vector512.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
<param name="vector">The vector that will have its absolute value computed.</param>
6262
<summary>Computes the absolute value of each element in a vector.</summary>
6363
<returns>A vector whose elements are the absolute value of the elements in <paramref name="vector" />.</returns>
64-
<remarks>To be added.</remarks>
64+
<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>
6565
<exception cref="T:System.NotSupportedException">The type of <paramref name="vector" /> (<typeparamref name="T" />) is not supported.</exception>
6666
</Docs>
6767
</Member>
@@ -1336,14 +1336,14 @@
13361336
</Parameter>
13371337
</Parameters>
13381338
<Docs>
1339-
<typeparam name="T">To be added.</typeparam>
1340-
<param name="value">To be added.</param>
1341-
<param name="min">To be added.</param>
1342-
<param name="max">To be added.</param>
1343-
<summary>To be added.</summary>
1344-
<returns>To be added.</returns>
1339+
<typeparam name="T">The type of the elements in the vector.</typeparam>
1340+
<param name="value">The vector to restrict.</param>
1341+
<param name="min">The minimum value.</param>
1342+
<param name="max">The maximum value.</param>
1343+
<summary>Restricts a vector between a minimum and a maximum value.</summary>
1344+
<returns>The restricted vector.</returns>
13451345
<remarks>To be added.</remarks>
1346-
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Clamp``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
1346+
<exception cref="T:System.NotSupportedException">The type of the elements in the vector (<typeparamref name="T" />) is not supported.</exception>
13471347
</Docs>
13481348
</Member>
13491349
<Member MemberName="ClampNative&lt;T&gt;">
@@ -7801,7 +7801,7 @@
78017801
<param name="right">The vector to compare with <paramref name="left" />.</param>
78027802
<summary>Computes the minimum of two vectors on a per-element basis.</summary>
78037803
<returns>A vector whose elements are the minimum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
7804-
<remarks>To be added.</remarks>
7804+
<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>
78057805
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
78067806
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Min``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
78077807
</Docs>

xml/System.Runtime.Intrinsics/Vector64.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1425,14 +1425,14 @@
14251425
</Parameter>
14261426
</Parameters>
14271427
<Docs>
1428-
<typeparam name="T">To be added.</typeparam>
1429-
<param name="value">To be added.</param>
1430-
<param name="min">To be added.</param>
1431-
<param name="max">To be added.</param>
1432-
<summary>To be added.</summary>
1433-
<returns>To be added.</returns>
1428+
<typeparam name="T">The type of the elements in the vector.</typeparam>
1429+
<param name="value">The vector to restrict.</param>
1430+
<param name="min">The minimum value.</param>
1431+
<param name="max">The maximum value.</param>
1432+
<summary>Restricts a vector between a minimum and a maximum value.</summary>
1433+
<returns>The restricted vector.</returns>
14341434
<remarks>To be added.</remarks>
1435-
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Clamp``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
1435+
<exception cref="T:System.NotSupportedException">The type of the elements in the vector (<typeparamref name="T" />) is not supported.</exception>
14361436
</Docs>
14371437
</Member>
14381438
<Member MemberName="ClampNative&lt;T&gt;">
@@ -6901,7 +6901,7 @@ This method may bypass the cache on certain platforms.
69016901
<param name="right">The vector to compare with <paramref name="left" />.</param>
69026902
<summary>Computes the maximum of two vectors on a per-element basis.</summary>
69036903
<returns>A vector whose elements are the maximum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
6904-
<remarks>To be added.</remarks>
6904+
<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>
69056905
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
69066906
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Max``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
69076907
</Docs>
@@ -7174,7 +7174,7 @@ This method may bypass the cache on certain platforms.
71747174
<param name="right">The vector to compare with <paramref name="left" />.</param>
71757175
<summary>Computes the minimum of two vectors on a per-element basis.</summary>
71767176
<returns>A vector whose elements are the minimum of the corresponding elements in <paramref name="left" /> and <paramref name="right" />.</returns>
7177-
<remarks>To be added.</remarks>
7177+
<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>
71787178
<exception cref="T:System.NotSupportedException">The type of <paramref name="left" /> and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
71797179
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Min``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
71807180
</Docs>

0 commit comments

Comments
 (0)