Back to Aurora Vision Library Lite website

You are here: Start » All Functions » Real » MinimumReal_OfArray

MinimumReal_OfArray


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 smallest value in an array of real numbers.

Syntax

void avl::MinimumReal_OfArray
(
	const atl::Optional<float>& inInitialValue,
	const atl::Array<float>& inArray,
	float& outMinimum,
	atl::Optional<atl::Conditional<int>&> outIndex = atl::NIL
)

Parameters

Name Type Default Description
Input value
 inInitialValue const Optional<float>& NIL Optional initial input Real value
Input value
 inArray const Array<float>& Input array of Real values
Output value
 outMinimum float& Output Real value of lowest value within inArray; returns inInitialValue if it is lower than any value within array or if array is empty
Output value
 outIndex Optional<Conditional<int>&> NIL Conditional output Integer index value of lowest value within inArray; returns Nil if inInitialValue is lower than any value within array or if array is empty

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outIndex.

Read more about Optional Outputs.

Description

Array version of MinimumReal.

Errors

List of possible exceptions:

Error type Description
DomainError Input array is empty and inInitialValue isn't set in MinimumReal_OfArray.

See Also