You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[release/9.0-staging] TensorPrimitives XML docs: MinNumber/ReciprocalSqrt/ReciprocalSqrtEstimate oversights (#109922)
* Fix XML docs for `MinNumber`
They ware accidentally referring to maxima
* Add `T.Sqrt` to XML docs of reciprocal square root
The effective code was copied from the other reciprocal
---------
Co-authored-by: delreluca <[email protected]>
Co-authored-by: Luca Del Re <[email protected]>
/// <summary>Searches for the largest number in the specified tensor.</summary>
14
+
/// <summary>Searches for the smallest number in the specified tensor.</summary>
15
15
/// <param name="x">The tensor, represented as a span.</param>
16
-
/// <returns>The maximum element in <paramref name="x"/>.</returns>
16
+
/// <returns>The minimum element in <paramref name="x"/>.</returns>
17
17
/// <exception cref="ArgumentException">Length of <paramref name="x" /> must be greater than zero.</exception>
18
18
/// <remarks>
19
19
/// <para>
20
-
/// The determination of the maximum element matches the IEEE 754:2019 `maximumNumber` function. Positive 0 is considered greater than negative 0.
20
+
/// The determination of the minimum element matches the IEEE 754:2019 `minimumNumber` function. Positive 0 is considered greater than negative 0.
21
21
/// </para>
22
22
/// <para>
23
23
/// This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different
@@ -28,7 +28,7 @@ public static T MinNumber<T>(ReadOnlySpan<T> x)
28
28
whereT:INumber<T>=>
29
29
MinMaxCore<T,MinNumberOperator<T>>(x);
30
30
31
-
/// <summary>Computes the element-wise maximum of the numbers in the specified tensors.</summary>
31
+
/// <summary>Computes the element-wise minimum of the numbers in the specified tensors.</summary>
32
32
/// <param name="x">The first tensor, represented as a span.</param>
33
33
/// <param name="y">The second tensor, represented as a span.</param>
34
34
/// <param name="destination">The destination tensor, represented as a span.</param>
@@ -41,7 +41,7 @@ public static T MinNumber<T>(ReadOnlySpan<T> x)
/// The determination of the maximum element matches the IEEE 754:2019 `maximumNumber` function. If either value is <see cref="IFloatingPointIeee754{TSelf}.NaN"/>
44
+
/// The determination of the minimum element matches the IEEE 754:2019 `minimumNumber` function. If either value is <see cref="IFloatingPointIeee754{TSelf}.NaN"/>
45
45
/// the other is returned. Positive 0 is considered greater than negative 0.
46
46
/// </para>
47
47
/// <para>
@@ -53,7 +53,7 @@ public static void MinNumber<T>(ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> de
/// The determination of the maximum element matches the IEEE 754:2019 `maximumNumber` function. If either value is <see cref="IFloatingPointIeee754{TSelf}.NaN"/>
67
+
/// The determination of the minimum element matches the IEEE 754:2019 `minimumNumber` function. If either value is <see cref="IFloatingPointIeee754{TSelf}.NaN"/>
68
68
/// the other is returned. Positive 0 is considered greater than negative 0.
/// <exception cref="DivideByZeroException"><typeparamref name="T"/> is an integer type and an element in <paramref name="x"/> is equal to zero.</exception>
/// <exception cref="DivideByZeroException"><typeparamref name="T"/> is an integer type and an element in <paramref name="x"/> is equal to zero.</exception>
0 commit comments