Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Array Statistics » GetMinimumElement

GetMinimumElement


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
Module: FoundationLite

Returns an array element that corresponds to the smallest value in the array of values.

Applications: Choosing one object from an array on the basis of some feature, e.g. the blob having the smallest convexity.

Syntax

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

Parameters

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

Hints

Errors

List of possible exceptions:

Error type Description
DomainError Empty input array in GetMinimumElement.
DomainError Inconsistent array sizes in GetMinimumElement.

See Also

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