Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Array » Array Statistics » GetNthElement_OrNil (GetNthElement OrNil)

GetNthElement_OrNil (GetNthElement OrNil)

Advanced

Module: FoundationLite

Returns the array element corresponding to the n-th biggest/smallest value from the inValues array; returns NIL if the arrays are empty.

Name Type Range Description
Input value inArray <T>Array Elements from which element corresponding to n-th value will be chosen
Input value inValues RealArray Values defining the order
Input value inN Integer 0 -
Input value inSortingOrder SortingOrder
Output value outElement <T>? Element from the array
Output value outValue Real? Nth biggest/smallest value
Output value outIndex Integer? Index of the found 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 GetNthElement_OrNil.
DomainError inN is negative in GetNthElement_OrNil.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of GetNthElement filter group visible as OrNil.