Back to Adaptive Vision Library website

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.

Returns the greatest value in an array of real numbers.

Syntax

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

Parameters

Name Type Default Description
inInitialValue const Optional<real>& NIL
inArray const Array<real>&
outMaximum real&
outIndex Conditional<int>&

Description

Array version of MaximumReal.

Hints

  • This is a primitive mathematical filter. It is recommended to use Formula Blocks instead.

Errors

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

See Also