Aurora Visio Studio TOP » Filter Reference » Array » Array Statistics » GetMaximumElement_OrNil
Module: | FoundationLite |
---|
Returns an array element that corresponds to the biggest value in the array of values; returns NIL if the arrays are empty.
Applications
Choosing one object from an array on the basis of some feature, e.g. the blob having the highest area.
Name | Type | Description | |
---|---|---|---|
inArray | <T>Array | Elements from which element corresponding to biggest value will be chosen | |
inValues | RealArray | Values defining the order | |
outElement | <T>? | Element from the array | |
outValue | Real? | Biggest value | |
outIndex | Integer? | Index of the biggest value |
The type of this filter is defined using the type variable T which represents any valid type. Read more.
Errors
This filter can throw an exception to report error. Read how to deal with errors in Error Handling.
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Inconsistent array sizes in GetMaximumElement_OrNil. |
Complexity Level
This filter is available on Advanced Complexity Level.
Filter Group
This filter is member of GetMaximumElement filter group.