Back to Adaptive Vision Library website
You are here: Start » Function Reference » Array Statistics » GetMaximumElement
GetMaximumElement
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
Returns an array element that corresponds to the biggest value in the array of values.
Syntax
void avl::GetMaximumElement ( const atl::Array<Type>& inArray, const atl::Array<atl::real>& inValues, Type& outElement, atl::real& outValue, int& outIndex )
Parameters
| Name | Type | Default | Description | |
|---|---|---|---|---|
 |
inArray | const Array<Type>& | Elements from which element corresponding to biggest value will be chosen | |
|
inValues | const Array<real>& | Values defining the order | |
 |
outElement | Type& | Element from the array | |
|
outValue | real& | Biggest value | |
|
outIndex | int& | Index of the biggest value |
Hints
- If the input array is not guaranteed to be non-empty, precede this filter with SkipEmptyArray.
Errors
| Error type | Description |
|---|---|
| DomainError | Inconsistent array sizes in GetMaximumElement. |
| DomainError | Empty input array in GetMaximumElement. |
