TensorPrimitives.MaxMagnitudeNumber Method

Definition

Namespace:

System.Numerics.Tensors

Assembly:

System.Numerics.Tensors.dll

Package:

System.Numerics.Tensors v9.0.0-rc.2.24473.5

Overloads

MaxMagnitudeNumber<T>(ReadOnlySpan<T>)	Searches for the number with the largest magnitude in the specified tensor.
MaxMagnitudeNumber<T>(ReadOnlySpan<T>, ReadOnlySpan<T>, Span<T>)	Computes the element-wise number with the largest magnitude in the specified tensors.
MaxMagnitudeNumber<T>(ReadOnlySpan<T>, T, Span<T>)	Computes the element-wise number with the largest magnitude in the specified tensors.

MaxMagnitudeNumber<T>(ReadOnlySpan<T>)

Source:

TensorPrimitives.MaxMagnitudeNumber.cs

Searches for the number with the largest magnitude in the specified tensor.

public:
generic <typename T>
 where T : System::Numerics::INumberBase<T> static T MaxMagnitudeNumber(ReadOnlySpan<T> x);

public static T MaxMagnitudeNumber<T> (ReadOnlySpan<T> x) where T : System.Numerics.INumberBase<T>;

static member MaxMagnitudeNumber : ReadOnlySpan<'T (requires 'T :> System.Numerics.INumberBase<'T>)> -> 'T (requires 'T :> System.Numerics.INumberBase<'T>)

Public Shared Function MaxMagnitudeNumber(Of T As INumberBase(Of T)) (x As ReadOnlySpan(Of T)) As T

Type Parameters

T

Parameters

x

ReadOnlySpan<T>

The tensor, represented as a span.

Returns

T

The element in x with the largest magnitude (absolute value).

Exceptions

ArgumentException

Length of x must be greater than zero.

Remarks

The determination of the maximum magnitude matches the IEEE 754:2019 `maximumMagnitudeNumber` function. 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.

MaxMagnitudeNumber<T>(ReadOnlySpan<T>, ReadOnlySpan<T>, Span<T>)

Source:

TensorPrimitives.MaxMagnitudeNumber.cs

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 MaxMagnitudeNumber(ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination);

public static void MaxMagnitudeNumber<T> (ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination) where T : System.Numerics.INumberBase<T>;

static member MaxMagnitudeNumber : 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 MaxMagnitudeNumber(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

x

ReadOnlySpan<T>

The first tensor, represented as a span.

y

ReadOnlySpan<T>

The second tensor, represented as a span.

destination

Span<T>

The destination tensor, represented as a span.

Exceptions

ArgumentException

y and destination reference overlapping memory locations and do not begin at the same location.

Remarks

This method effectively computes destination[i] = T.MaxMagnitudeNumber(x[i], y[i]).

The determination of the maximum magnitude matches the IEEE 754:2019 `maximumMagnitudeNumber` function. If the 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.

MaxMagnitudeNumber<T>(ReadOnlySpan<T>, T, Span<T>)

Source:

TensorPrimitives.MaxMagnitudeNumber.cs

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 MaxMagnitudeNumber(ReadOnlySpan<T> x, T y, Span<T> destination);

public static void MaxMagnitudeNumber<T> (ReadOnlySpan<T> x, T y, Span<T> destination) where T : System.Numerics.INumberBase<T>;

static member MaxMagnitudeNumber : 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 MaxMagnitudeNumber(Of T As INumberBase(Of T)) (x As ReadOnlySpan(Of T), y As T, destination As Span(Of T))

Type Parameters

T

Parameters

x

ReadOnlySpan<T>

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

ArgumentException

x and destination reference overlapping memory locations and do not begin at the same location.

Remarks

This method effectively computes destination[i] = T.MaxMagnitudeNumber(x[i], y).

The determination of the maximum magnitude matches the IEEE 754:2019 `maximumMagnitudeNumber` function. If the 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.