ExtensionMethods.max Method (ConcreteArray<fcomplex, Array<fcomplex>, InArray<fcomplex>, OutArray<fcomplex>, RetArray<fcomplex>, Storage<fcomplex>>, Nullable<Int32>, OutArray<Int64>)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Computes maximum elements along the specified dimension of A, recognizing NaNs.

[ILNumerics numpy Module]

Namespace: ILNumerics
Assembly: ILNumerics.numpy (in ILNumerics.numpy.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

public static RetArray<fcomplex> max(
	this ConcreteArray<fcomplex, Array<fcomplex>, InArray<fcomplex>, OutArray<fcomplex>, RetArray<fcomplex>, Storage<fcomplex>> A,
	Nullable<int> axis = null,
	OutArray<long> indices = null
)

<ExtensionAttribute>
Public Shared Function max ( 
	A As ConcreteArray(Of fcomplex, Array(Of fcomplex), InArray(Of fcomplex), OutArray(Of fcomplex), RetArray(Of fcomplex), Storage(Of fcomplex)),
	Optional axis As Nullable(Of Integer) = Nothing,
	Optional indices As OutArray(Of Long) = Nothing
) As RetArray(Of fcomplex)

Dim A As ConcreteArray(Of fcomplex, Array(Of fcomplex), InArray(Of fcomplex), OutArray(Of fcomplex), RetArray(Of fcomplex), Storage(Of fcomplex))
Dim axis As Nullable(Of Integer)
Dim indices As OutArray(Of Long)
Dim returnValue As RetArray(Of fcomplex)

returnValue = A.max(axis, indices)

Parameters

A: Type: ILNumerics.Core.Arrays.ConcreteArray<fcomplex, Array<fcomplex>, InArray<fcomplex>, OutArray<fcomplex>, RetArray<fcomplex>, Storage<fcomplex>>
Array to compute the maximum(s) for. This is not altered.
axis (Optional): Type: System.Nullable<Int32>
[Optional] The working dimension. Default: (null) finds the maximum within the whole array.
indices (Optional): Type: ILNumerics.OutArray<Int64>
[Optional] Also return the indices of the maximum values found from A. Default: (null) indices are not returned.

Return Value

Type: RetArray<fcomplex>

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConcreteArray<fcomplex, Array<fcomplex>, InArray<fcomplex>, OutArray<fcomplex>, RetArray<fcomplex>, Storage<fcomplex>>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Negative dimension specifier 'axis' will be shifted into the range of valid dimension indices. -1 corresponds to the last dimension.

max(ConcreteArray<fcomplex, Array<fcomplex> , InArray<fcomplex> , OutArray<fcomplex> , RetArray<fcomplex> , Storage<fcomplex> > , Nullable<Int32> , OutArray<Int64> ) prioritizes NaN values over non-NaN values. I.e.: if any of the elements is NaN the respective result value will be NaN also. Conversely, max(BaseArray<fcomplex>, OutArray<Int64>, Int32, Boolean), ignores NaN values and gives the maximum among the non-NaN values, if possible. This corresponds to the behavior of ILNumerics version 4, Matlab(R) a.s.f.

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

max Overload

ILNumerics Namespace

MathInternal.max(BaseArray<fcomplex>, OutArray<Int64>, Int32, Boolean)

ExtensionMethods.argmax(ConcreteArray<fcomplex, Array<fcomplex>, InArray<fcomplex>, OutArray<fcomplex>, RetArray<fcomplex>, Storage<fcomplex>>, Nullable<Int32>, OutArray<fcomplex>)

MathInternal.maxall(ConcreteArray<fcomplex, Array<fcomplex>, InArray<fcomplex>, OutArray<fcomplex>, RetArray<fcomplex>, Storage<fcomplex>>, OutArray<Int64>, StorageOrders, Boolean)

MathInternal.minall(ConcreteArray<fcomplex, Array<fcomplex>, InArray<fcomplex>, OutArray<fcomplex>, RetArray<fcomplex>, Storage<fcomplex>>, OutArray<Int64>, StorageOrders, Boolean)