MaximumDouble_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

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

Syntax

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

Parameters

Name	Type	Default	Description
inArray	const Array<double>&		Input array of Double values
outMaximum	Conditional<double>&		Conditional output Double value of highest value within inArray; returns Nil if array is empty
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.