Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Real » MaximumReal_OfArray_OrNil

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

Returns the greatest value in an array of real numbers; returns NIL if the array is empty.

Syntax

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

Parameters

Name Type Default Description
Input value inArray const Array<float>& Input array of Real values
Output value outMaximum Conditional<float>& Conditional output Real value of highest value within inArray; returns Nil if array is empty
Output value outIndex Optional<Conditional<int>&> NIL Conditional output Integer index value of highest value within inArray; returns Nil 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.