TensorPrimitives.Max Method

Definition

Namespace:

System.Numerics.Tensors

Assembly:

System.Numerics.Tensors.dll

Package:

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

Overloads

Max(ReadOnlySpan<Single>, ReadOnlySpan<Single>, Span<Single>)	Computes the element-wise maximum of the single-precision floating-point numbers in the specified tensors.
Max(ReadOnlySpan<Single>)	Searches for the largest single-precision floating-point number in the specified tensor.
Max<T>(ReadOnlySpan<T>, ReadOnlySpan<T>, Span<T>)	Computes the element-wise maximum of the numbers in the specified tensors.
Max<T>(ReadOnlySpan<T>, T, Span<T>)	Computes the element-wise maximum of the numbers in the specified tensors.
Max<T>(ReadOnlySpan<T>)	Searches for the largest number in the specified tensor.

Max(ReadOnlySpan<Single>, ReadOnlySpan<Single>, Span<Single>)

Source:

TensorPrimitives.Single.cs

Computes the element-wise maximum of the single-precision floating-point numbers in the specified tensors.

public:
 static void Max(ReadOnlySpan<float> x, ReadOnlySpan<float> y, Span<float> destination);

public static void Max (ReadOnlySpan<float> x, ReadOnlySpan<float> y, Span<float> destination);

static member Max : ReadOnlySpan<single> * ReadOnlySpan<single> * Span<single> -> unit

Public Shared Sub Max (x As ReadOnlySpan(Of Single), y As ReadOnlySpan(Of Single), destination As Span(Of Single))

Parameters

x

ReadOnlySpan<Single>

The first tensor, represented as a span.

y

ReadOnlySpan<Single>

The second tensor, represented as a span.

destination

Span<Single>

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] = MathF.Max(x[i], y[i]).

The determination of the maximum element matches the IEEE 754:2019 `maximum` function. If either value is equal to NaN, that value is stored as the result. Positive 0 is considered greater than negative 0.

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.

Max(ReadOnlySpan<Single>)

Source:

TensorPrimitives.Single.cs

Searches for the largest single-precision floating-point number in the specified tensor.

public:
 static float Max(ReadOnlySpan<float> x);

public static float Max (ReadOnlySpan<float> x);

static member Max : ReadOnlySpan<single> -> single

Public Shared Function Max (x As ReadOnlySpan(Of Single)) As Single

Parameters

x

ReadOnlySpan<Single>

The tensor, represented as a span.

Returns

Single

The maximum element in x.

Exceptions

ArgumentException

Length of x must be greater than zero.

Remarks

The determination of the maximum element matches the IEEE 754:2019 `maximum` function. If any value equal to NaN is present, the first is returned. Positive 0 is considered greater than negative 0.

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.

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

Source:

TensorPrimitives.Max.cs

Computes the element-wise maximum of the numbers in the specified tensors.

public:
generic <typename T>
 where T : System::Numerics::INumber<T> static void Max(ReadOnlySpan<T> x, ReadOnlySpan<T> y, Span<T> destination);

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

static member Max : ReadOnlySpan<'T (requires 'T :> System.Numerics.INumber<'T>)> * ReadOnlySpan<'T (requires 'T :> System.Numerics.INumber<'T>)> * Span<'T (requires 'T :> System.Numerics.INumber<'T>)> -> unit (requires 'T :> System.Numerics.INumber<'T>)

Public Shared Sub Max(Of T As INumber(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.Max(x[i], y[i]).

The determination of the maximum element matches the IEEE 754:2019 `maximum` function. If either value is equal to NaN, that value is stored as the result. Positive 0 is considered greater than negative 0.

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.

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

Source:

TensorPrimitives.Max.cs

Computes the element-wise maximum of the numbers in the specified tensors.

public:
generic <typename T>
 where T : System::Numerics::INumber<T> static void Max(ReadOnlySpan<T> x, T y, Span<T> destination);

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

static member Max : ReadOnlySpan<'T (requires 'T :> System.Numerics.INumber<'T>)> * 'T * Span<'T (requires 'T :> System.Numerics.INumber<'T>)> -> unit (requires 'T :> System.Numerics.INumber<'T>)

Public Shared Sub Max(Of T As INumber(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.Max(x[i], y).

The determination of the maximum element matches the IEEE 754:2019 `maximum` function. If either value is equal to NaN, that value is stored as the result. Positive 0 is considered greater than negative 0.

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.

Max<T>(ReadOnlySpan<T>)

Source:

TensorPrimitives.Max.cs

Searches for the largest number in the specified tensor.

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

public static T Max<T> (ReadOnlySpan<T> x) where T : System.Numerics.INumber<T>;

static member Max : ReadOnlySpan<'T (requires 'T :> System.Numerics.INumber<'T>)> -> 'T (requires 'T :> System.Numerics.INumber<'T>)

Public Shared Function Max(Of T As INumber(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 maximum element in x.

Exceptions

ArgumentException

Length of x must be greater than zero.

Remarks

The determination of the maximum element matches the IEEE 754:2019 `maximum` function. If any value equal to NaN is present, the first is returned. Positive 0 is considered greater than negative 0.

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.