Back to Aurora Vision Library Lite website

You are here: Start » All Functions » Array Statistics » GetMaximumElement_OrNil

GetMaximumElement_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 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.

Syntax

void avl::GetMaximumElement_OrNil
(
	const atl::Array<Type>& inArray,
	const atl::Array<float>& inValues,
	typename atl::ToConditionalType<Type>::Type& outElement,
	atl::Conditional<float>& outValue,
	atl::Conditional<int>& outIndex
)

Parameters

Name Type Default Description
Input value inArray const Array<Type>& Elements from which element corresponding to biggest value will be chosen
Input value inValues const Array<float>& Values defining the order
Output value outElement typename ToConditionalType<Type>::Type& Element from the array
Output value outValue Conditional<float>& Biggest value
Output value outIndex Conditional<int>& Index of the biggest value

Errors

List of possible exceptions:

Error type Description
DomainError Inconsistent array sizes in GetMaximumElement_OrNil.