ExtensionMethods.GetLimits Method (BaseArray<UInt16>, UInt16, UInt16)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Finds the minimum and maximum values among all elements of A.

[ILNumerics Core Module]

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

Syntax

public static bool GetLimits(
	this BaseArray<ushort> A,
	out ushort min,
	out ushort max
)

<ExtensionAttribute>
Public Shared Function GetLimits ( 
	A As BaseArray(Of UShort),
	<OutAttribute> ByRef min As UShort,
	<OutAttribute> ByRef max As UShort
) As Boolean

Dim A As BaseArray(Of UShort)
Dim min As UShort
Dim max As UShort
Dim returnValue As Boolean

returnValue = A.GetLimits(min, max)

Parameters

A: Type: ILNumerics.BaseArray<UInt16>
Input array.
min: Type: System.UInt16
[Output] The minimum value in A.
max: Type: System.UInt16
[Output] The maximum value in A.

Return Value

Type: Boolean
True, if the minimum and maximum values could be computed. False otherwise.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type BaseArray<UInt16>. 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).

Exceptions

Exception	Condition
ArgumentException	If A is empty.

Remarks

The operation is efficiently performed on all elements of the input array A in a single run.

The operation is performed in multiple threads, according to the current settings of MaxNumberThreads.

The input array A is not altered.

The function always succeeds and returns true for non-empty arrays of integer (non-floating point) element types. Overloads for floating point element types the function succeeds on non-empty arrays which have at least one element other than NaN.

[ILNumerics Core Module]

Reference

ExtensionMethods Class

GetLimits Overload

ILNumerics Namespace