Back to Aurora Vision Library Lite website
You are here: Start » All Functions » Array Statistics » GetNthElement_OrNil
GetNthElement_OrNil
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
Header: | STD.h |
---|---|
Namespace: | avl |
Returns the array element corresponding to the n-th biggest/smallest value from the inValues array; returns NIL if the arrays are empty.
Syntax
void avl::GetNthElement_OrNil ( const atl::Array<Type>& inArray, const atl::Array<float>& inValues, const int inN, avl::SortingOrder::Type inSortingOrder, typename atl::ToConditionalType<Type>::Type& outElement, atl::Conditional<float>& outValue, atl::Conditional<int>& outIndex )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inArray | const Array<Type>& | Elements from which element corresponding to n-th value will be chosen | |||
inValues | const Array<float>& | Values defining the order | |||
inN | const int | 0 - | |||
inSortingOrder | SortingOrder::Type | ||||
outElement | typename ToConditionalType<Type>::Type& | Element from the array | |||
outValue | Conditional<float>& | Nth biggest/smallest value | |||
outIndex | Conditional<int>& | Index of the found value |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Inconsistent array sizes in GetNthElement_OrNil. |
DomainError | inN is negative in GetNthElement_OrNil. |