You are here: Start » Function Reference » Real » MaximumReal_OfArray

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

Syntax

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

Parameters

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

Description

Array version of MaximumReal.

Errors

List of possible exceptions: