Back to Adaptive Vision Library website

You are here: Start » Function Reference » Array Statistics » GetMinimumElement_OrNil

GetMinimumElement_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 smallest value in the array of values; returns NIL if the arrays are empty.

Syntax

void avl::GetMinimumElement_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
inArray const Array<Type>& Elements from which element corresponding to smallest value will be chosen
inValues const Array<float>& Values defining the order
outElement typename ToConditionalType<Type>::Type& Element from the array
outValue Conditional<float>& Smallest value
outIndex Conditional<int>& Index of the smallest value

Errors

List of possible exceptions:

Error type Description
DomainError Inconsistent array sizes in GetMinimumElement_OrNil.