ExtensionMethodsmin Method (ConcreteArrayUInt16, ArrayUInt16, InArrayUInt16, OutArrayUInt16, RetArrayUInt16, StorageUInt16, NullableInt32, OutArrayInt64)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Computes minimum 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<ushort> min(
	this ConcreteArray<ushort, Array<ushort>, InArray<ushort>, OutArray<ushort>, RetArray<ushort>, Storage<ushort>> A,
	Nullable<int> axis = null,
	OutArray<long> indices = null
)

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

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

returnValue = A.min(axis, indices)

Parameters

A: Type: ILNumerics.Core.ArraysConcreteArrayUInt16, ArrayUInt16, InArrayUInt16, OutArrayUInt16, RetArrayUInt16, StorageUInt16
Array to compute the minimum(s) for. This is not altered.
axis (Optional): Type: SystemNullableInt32
[Optional] The working dimension. Default: (null) finds the minimum within the whole array.
indices (Optional): Type: ILNumericsOutArrayInt64
[Optional] Also return the indices of the minimum values found from A. Default: (null) indices are not returned.

Return Value

Type: RetArrayUInt16

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConcreteArrayUInt16, ArrayUInt16, InArrayUInt16, OutArrayUInt16, RetArrayUInt16, StorageUInt16. 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.

min(ConcreteArrayUInt16, ArrayUInt16, InArrayUInt16, OutArrayUInt16, RetArrayUInt16, StorageUInt16, NullableInt32, OutArrayInt64) 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, min(BaseArrayUInt16, OutArrayInt64, Int32, Boolean), ignores NaN values and gives the minimum 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

min Overload

ILNumerics Namespace

MathInternal.min(BaseArrayUInt16, OutArrayInt64, Int32, Boolean)

ExtensionMethodsargmin(ConcreteArrayUInt16, ArrayUInt16, InArrayUInt16, OutArrayUInt16, RetArrayUInt16, StorageUInt16, NullableInt32, OutArrayUInt16)

MathInternal.minall(ConcreteArrayUInt16, ArrayUInt16, InArrayUInt16, OutArrayUInt16, RetArrayUInt16, StorageUInt16, OutArrayInt64, StorageOrders, Boolean)