Aurora Visio Studio TOP » Filter Reference » Array » Array Statistics » GetNthElement

GetNthElement

Advanced

Module: FoundationLite

Returns the array element corresponding to the n-th biggest/smallest value from the inValues array.

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.

Hints

  • You must guarantee that the input arrays have at least N+1 elements.

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 Empty input array in GetNthElement.
DomainError Inconsistent array sizes in GetNthElement.
DomainError inN is negative or exceeds the input arrays size in GetNthElement.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of GetNthElement filter group.

See Also

  • GetMinimumElement – Returns an array element that corresponds to the smallest value in the array of values.
  • GetMaximumElement – Returns an array element that corresponds to the biggest value in the array of values.