Skip to content

Commit e669d4a

Browse files
authored
Add remark to ConditionalSelect (#10885)
1 parent f113ee0 commit e669d4a

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

xml/System.Numerics/Vector.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1870,7 +1870,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
18701870
<param name="right">The second source vector.</param>
18711871
<summary>Creates a new single-precision vector with elements selected between two specified single-precision source vectors based on an integral mask vector.</summary>
18721872
<returns>The new vector with elements selected based on the mask.</returns>
1873-
<remarks>To be added.</remarks>
1873+
<remarks>The returned vector is equivalent to <paramref name="condition" /> <c>?</c> <paramref name="left" /> <c>:</c> <paramref name="right" /> on a per-bit basis.</remarks>
18741874
</Docs>
18751875
</Member>
18761876
<Member MemberName="ConditionalSelect">
@@ -1915,7 +1915,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
19151915
<param name="right">The second source vector.</param>
19161916
<summary>Creates a new double-precision vector with elements selected between two specified double-precision source vectors based on an integral mask vector.</summary>
19171917
<returns>The new vector with elements selected based on the mask.</returns>
1918-
<remarks>To be added.</remarks>
1918+
<remarks>The returned vector is equivalent to <paramref name="condition" /> <c>?</c> <paramref name="left" /> <c>:</c> <paramref name="right" /> on a per-bit basis.</remarks>
19191919
</Docs>
19201920
</Member>
19211921
<Member MemberName="ConditionalSelect&lt;T&gt;">
@@ -1996,7 +1996,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
19961996
<param name="right">The second source vector.</param>
19971997
<summary>Creates a new vector of a specified type with elements selected between two specified source vectors of the same type based on an integral mask vector.</summary>
19981998
<returns>The new vector with elements selected based on the mask.</returns>
1999-
<remarks>To be added.</remarks>
1999+
<remarks>The returned vector is equivalent to <paramref name="condition" /> <c>?</c> <paramref name="left" /> <c>:</c> <paramref name="right" /> on a per-bit basis.</remarks>
20002000
</Docs>
20012001
</Member>
20022002
<Member MemberName="ConvertToDouble">

xml/System.Runtime.Intrinsics/Vector128.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1728,7 +1728,7 @@
17281728
<param name="right">The vector that is selected when the corresponding bit in <paramref name="condition" /> is zero.</param>
17291729
<summary>Conditionally selects a value from two vectors on a bitwise basis.</summary>
17301730
<returns>A vector whose bits come from <paramref name="left" /> or <paramref name="right" /> based on the value of <paramref name="condition" />.</returns>
1731-
<remarks>To be added.</remarks>
1731+
<remarks>The returned vector is equivalent to <paramref name="condition" /> <c>?</c> <paramref name="left" /> <c>:</c> <paramref name="right" /> on a per-bit basis.</remarks>
17321732
<exception cref="T:System.NotSupportedException">The type of <paramref name="condition" />, <paramref name="left" />, and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
17331733
</Docs>
17341734
</Member>

xml/System.Runtime.Intrinsics/Vector256.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1497,7 +1497,7 @@
14971497
<param name="right">The vector that is selected when the corresponding bit in <paramref name="condition" /> is zero.</param>
14981498
<summary>Conditionally selects a value from two vectors on a bitwise basis.</summary>
14991499
<returns>A vector whose bits come from <paramref name="left" /> or <paramref name="right" /> based on the value of <paramref name="condition" />.</returns>
1500-
<remarks>To be added.</remarks>
1500+
<remarks>The returned vector is equivalent to <paramref name="condition" /> <c>?</c> <paramref name="left" /> <c>:</c> <paramref name="right" /> on a per-bit basis.</remarks>
15011501
<exception cref="T:System.NotSupportedException">The type of <paramref name="condition" />, <paramref name="left" />, and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
15021502
</Docs>
15031503
</Member>

xml/System.Runtime.Intrinsics/Vector512.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1228,7 +1228,7 @@
12281228
<param name="right">The vector that is selected when the corresponding bit in <paramref name="condition" /> is zero.</param>
12291229
<summary>Conditionally selects a value from two vectors on a bitwise basis.</summary>
12301230
<returns>A vector whose bits come from <paramref name="left" /> or <paramref name="right" /> based on the value of <paramref name="condition" />.</returns>
1231-
<remarks>To be added.</remarks>
1231+
<remarks>The returned vector is equivalent to <paramref name="condition" /> <c>?</c> <paramref name="left" /> <c>:</c> <paramref name="right" /> on a per-bit basis.</remarks>
12321232
<exception cref="T:System.NotSupportedException">The type of <paramref name="condition" />, <paramref name="left" />, and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
12331233
</Docs>
12341234
</Member>

xml/System.Runtime.Intrinsics/Vector64.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1391,7 +1391,7 @@
13911391
<param name="right">The vector that is selected when the corresponding bit in <paramref name="condition" /> is zero.</param>
13921392
<summary>Conditionally selects a value from two vectors on a bitwise basis.</summary>
13931393
<returns>A vector whose bits come from <paramref name="left" /> or <paramref name="right" /> based on the value of <paramref name="condition" />.</returns>
1394-
<remarks>To be added.</remarks>
1394+
<remarks>The returned vector is equivalent to <paramref name="condition" /> <c>?</c> <paramref name="left" /> <c>:</c> <paramref name="right" /> on a per-bit basis.</remarks>
13951395
<exception cref="T:System.NotSupportedException">The type of <paramref name="condition" />, <paramref name="left" />, and <paramref name="right" /> (<typeparamref name="T" />) is not supported.</exception>
13961396
</Docs>
13971397
</Member>

0 commit comments

Comments
 (0)