| File: System\Numerics\Tensors\netcore\TensorPrimitives.MaxNumber.cs | Web Access |
| Project: src\runtime\src\libraries\System.Numerics.Tensors\src\System.Numerics.Tensors.csproj (System.Numerics.Tensors) |
// Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. using System.Runtime.CompilerServices; using System.Runtime.Intrinsics; namespace System.Numerics.Tensors { public static partial class TensorPrimitives { /// <summary>Searches for the largest number in the specified tensor.</summary> /// <param name="x">The tensor, represented as a span.</param> /// <returns>The maximum element in <paramref name="x"/>.</returns> /// <exception cref="ArgumentException">Length of <paramref name="x" /> must be greater than zero.</exception> /// <remarks> /// <para> /// The determination of the maximum element matches the IEEE 754:2019 `maximumNumber` function. Positive 0 is considered greater than negative 0. /// </para> /// <para> /// This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different /// operating systems or architectures. /// </para> /// </remarks> public static T MaxNumber<T>(ReadOnlySpan<T> x) where T : INumber<T> { if (typeof(T) == typeof(Half) && TryMinMaxHalfAsInt16<T, MaxNumberOperator<float>>(x, out T result)) { return result; } return MinMaxCore<T, MaxNumberOperator<T>>(x); } /// <summary>Computes the element-wise maximum of the numbers in the specified tensors.</summary> /// <param name="x">The first tensor, represented as a span.</param> /// <param name="y">The second tensor, represented as a span.</param> /// <param name="destination">The destination tensor, represented as a span.</param> /// <exception cref="ArgumentException">Length of <paramref name="x" /> must be same as length of <paramref name="y" />.</exception> /// <exception cref="ArgumentException">Destination is too short.</exception> /// <exception cref="ArgumentException"><paramref name="x"/> and <paramref name="destination"/> reference overlapping memory locations and do not begin at the same location.</exception> /// <exception cref="ArgumentException"><paramref name="y"/> and <paramref name="destination"/> reference overlapping memory locations and do not begin at the same location.</exception> /// <remarks> /// <para> /// This method effectively computes <c><paramref name="destination" />[i] = <typeparamref name="T"/>.MaxNumber(<paramref name="x" />[i], <paramref name="y" />[i])</c>. /// </para> /// <para> /// The determination of the maximum element matches the IEEE 754:2019 `maximumNumber` function. If either value is <see cref="IFloatingPointIeee754{TSelf}.NaN"/> /// the other is returned. Positive 0 is considered greater than negative 0. /// </para> /// <para> /// This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different /// operating systems or architectures. /// </para> /// </remarks> public static void MaxNumber<T>(ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination) where T : INumber<T> { if (typeof(T) == typeof(Half) && TryAggregateInvokeHalfAsInt16<T, MaxNumberOperator<float>>(x, y, destination)) { return; } InvokeSpanSpanIntoSpan<T, MaxNumberOperator<T>>(x, y, destination); } /// <summary>Computes the element-wise maximum of the numbers in the specified tensors.</summary> /// <param name="x">The first tensor, represented as a span.</param> /// <param name="y">The second tensor, represented as a scalar.</param> /// <param name="destination">The destination tensor, represented as a span.</param> /// <exception cref="ArgumentException">Destination is too short.</exception> /// <exception cref="ArgumentException"><paramref name="x"/> and <paramref name="destination"/> reference overlapping memory locations and do not begin at the same location.</exception> /// <remarks> /// <para> /// This method effectively computes <c><paramref name="destination" />[i] = <typeparamref name="T"/>.MaxNumber(<paramref name="x" />[i], <paramref name="y" />)</c>. /// </para> /// <para> /// The determination of the maximum element matches the IEEE 754:2019 `maximumNumber` function. If either value is <see cref="IFloatingPointIeee754{TSelf}.NaN"/> /// the other is returned. Positive 0 is considered greater than negative 0. /// </para> /// <para> /// This method may call into the underlying C runtime or employ instructions specific to the current architecture. Exact results may differ between different /// operating systems or architectures. /// </para> /// </remarks> public static void MaxNumber<T>(ReadOnlySpan<T> x, T y, Span<T> destination) where T : INumber<T> { if (typeof(T) == typeof(Half) && TryAggregateInvokeHalfAsInt16<T, MaxNumberOperator<float>>(x, y, destination)) { return; } InvokeSpanScalarIntoSpan<T, MaxNumberOperator<T>>(x, y, destination); } /// <summary>T.MaxNumber(x, y)</summary> internal readonly struct MaxNumberOperator<T> : IAggregationOperator<T> where T : INumber<T> { public static bool Vectorizable => true; public static T Invoke(T x, T y) => T.MaxNumber(x, y); [MethodImpl(MethodImplOptions.AggressiveInlining)] public static Vector128<T> Invoke(Vector128<T> x, Vector128<T> y) { return Vector128.MaxNumber(x, y); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static Vector256<T> Invoke(Vector256<T> x, Vector256<T> y) { return Vector256.MaxNumber(x, y); } [MethodImpl(MethodImplOptions.AggressiveInlining)] public static Vector512<T> Invoke(Vector512<T> x, Vector512<T> y) { return Vector512.MaxNumber(x, y); } public static T Invoke(Vector128<T> x) => HorizontalAggregate<T, MaxNumberOperator<T>>(x); public static T Invoke(Vector256<T> x) => HorizontalAggregate<T, MaxNumberOperator<T>>(x); public static T Invoke(Vector512<T> x) => HorizontalAggregate<T, MaxNumberOperator<T>>(x); } } }