TensorPrimitives.MaxMagnitude Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
MaxMagnitude(ReadOnlySpan<Single>, ReadOnlySpan<Single>, Span<Single>) |
Computes the element-wise single-precision floating-point number with the largest magnitude in the specified tensors. |
MaxMagnitude(ReadOnlySpan<Single>) |
Searches for the single-precision floating-point number with the largest magnitude in the specified tensor. |
MaxMagnitude<T>(ReadOnlySpan<T>) |
Searches for the number with the largest magnitude in the specified tensor. |
MaxMagnitude<T>(ReadOnlySpan<T>, ReadOnlySpan<T>, Span<T>) |
Computes the element-wise number with the largest magnitude in the specified tensors. |
MaxMagnitude<T>(ReadOnlySpan<T>, T, Span<T>) |
Computes the element-wise number with the largest magnitude in the specified tensors. |
MaxMagnitude(ReadOnlySpan<Single>, ReadOnlySpan<Single>, Span<Single>)
- Source:
- TensorPrimitives.cs
- Source:
- TensorPrimitives.Single.cs
- Source:
- TensorPrimitives.Single.cs
Computes the element-wise single-precision floating-point number with the largest magnitude in the specified tensors.
public:
static void MaxMagnitude(ReadOnlySpan<float> x, ReadOnlySpan<float> y, Span<float> destination);
public static void MaxMagnitude (ReadOnlySpan<float> x, ReadOnlySpan<float> y, Span<float> destination);
static member MaxMagnitude : ReadOnlySpan<single> * ReadOnlySpan<single> * Span<single> -> unit
Public Shared Sub MaxMagnitude (x As ReadOnlySpan(Of Single), y As ReadOnlySpan(Of Single), destination As Span(Of Single))
Parameters
The first tensor, represented as a span.
The second tensor, represented as a span.
Exceptions
y
and destination
reference overlapping memory locations and do not begin at the same location.
Remarks
This method effectively computes
.destination
[i] = MathF.MaxMagnitude(x
[i], y
[i])
Applies to
MaxMagnitude(ReadOnlySpan<Single>)
- Source:
- TensorPrimitives.cs
- Source:
- TensorPrimitives.Single.cs
- Source:
- TensorPrimitives.Single.cs
Searches for the single-precision floating-point number with the largest magnitude in the specified tensor.
public:
static float MaxMagnitude(ReadOnlySpan<float> x);
public static float MaxMagnitude (ReadOnlySpan<float> x);
static member MaxMagnitude : ReadOnlySpan<single> -> single
Public Shared Function MaxMagnitude (x As ReadOnlySpan(Of Single)) As Single
Parameters
The tensor, represented as a span.
Returns
The element in x
with the largest magnitude (absolute value).
Exceptions
Length of x
must be greater than zero.
Remarks
The determination of the maximum magnitude matches the IEEE 754:2019 `maximumMagnitude` function. If any value equal to NaN is present, the first is returned. If two values have the same magnitude and one is positive and the other is negative, the positive value is considered to have the larger magnitude.
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.
Applies to
MaxMagnitude<T>(ReadOnlySpan<T>)
Searches for the number with the largest magnitude in the specified tensor.
public:
generic <typename T>
where T : System::Numerics::INumberBase<T> static T MaxMagnitude(ReadOnlySpan<T> x);
public static T MaxMagnitude<T> (ReadOnlySpan<T> x) where T : System.Numerics.INumberBase<T>;
static member MaxMagnitude : ReadOnlySpan<'T (requires 'T :> System.Numerics.INumberBase<'T>)> -> 'T (requires 'T :> System.Numerics.INumberBase<'T>)
Public Shared Function MaxMagnitude(Of T As INumberBase(Of T)) (x As ReadOnlySpan(Of T)) As T
Type Parameters
- T
Parameters
The tensor, represented as a span.
Returns
The element in x
with the largest magnitude (absolute value).
Exceptions
Length of x
must be greater than zero.
Remarks
The determination of the maximum magnitude matches the IEEE 754:2019 `maximumMagnitude` function. If any value equal to NaN is present, the first is returned. If two values have the same magnitude and one is positive and the other is negative, the positive value is considered to have the larger magnitude.
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.
Applies to
MaxMagnitude<T>(ReadOnlySpan<T>, ReadOnlySpan<T>, Span<T>)
Computes the element-wise number with the largest magnitude in the specified tensors.
public:
generic <typename T>
where T : System::Numerics::INumberBase<T> static void MaxMagnitude(ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination);
public static void MaxMagnitude<T> (ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination) where T : System.Numerics.INumberBase<T>;
static member MaxMagnitude : ReadOnlySpan<'T (requires 'T :> System.Numerics.INumberBase<'T>)> * ReadOnlySpan<'T (requires 'T :> System.Numerics.INumberBase<'T>)> * Span<'T (requires 'T :> System.Numerics.INumberBase<'T>)> -> unit (requires 'T :> System.Numerics.INumberBase<'T>)
Public Shared Sub MaxMagnitude(Of T As INumberBase(Of T)) (x As ReadOnlySpan(Of T), y As ReadOnlySpan(Of T), destination As Span(Of T))
Type Parameters
- T
Parameters
The first tensor, represented as a span.
The second tensor, represented as a span.
- destination
- Span<T>
The destination tensor, represented as a span.
Exceptions
y
and destination
reference overlapping memory locations and do not begin at the same location.
Remarks
This method effectively computes
.destination
[i] = T
.MaxMagnitude(x
[i], y
[i])
Applies to
MaxMagnitude<T>(ReadOnlySpan<T>, T, Span<T>)
Computes the element-wise number with the largest magnitude in the specified tensors.
public:
generic <typename T>
where T : System::Numerics::INumberBase<T> static void MaxMagnitude(ReadOnlySpan<T> x, T y, Span<T> destination);
public static void MaxMagnitude<T> (ReadOnlySpan<T> x, T y, Span<T> destination) where T : System.Numerics.INumberBase<T>;
static member MaxMagnitude : ReadOnlySpan<'T (requires 'T :> System.Numerics.INumberBase<'T>)> * 'T * Span<'T (requires 'T :> System.Numerics.INumberBase<'T>)> -> unit (requires 'T :> System.Numerics.INumberBase<'T>)
Public Shared Sub MaxMagnitude(Of T As INumberBase(Of T)) (x As ReadOnlySpan(Of T), y As T, destination As Span(Of T))
Type Parameters
- T
Parameters
The first tensor, represented as a span.
- y
- T
The second tensor, represented as a scalar.
- destination
- Span<T>
The destination tensor, represented as a span.
Exceptions
x
and destination
reference overlapping memory locations and do not begin at the same location.
Remarks
This method effectively computes
.destination
[i] = T
.MaxMagnitude(x
[i], y
)
Applies to
.NET