Back to FabImage 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.

Header:STD.h
Namespace:fil

Returns the greatest value in an array of real numbers.

Syntax

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

Parameters

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

Optional Outputs

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

Read more about Optional Outputs.

Description

Array version of MaximumReal.

Errors

List of possible exceptions:

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

See Also