Back to FabImage Library Lite website

You are here: Start » Integer » MaximumInteger_OfArray

MaximumInteger_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 integer numbers.

Syntax

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

Parameters

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

Description

Array version of MaximumInteger.

Errors

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

See Also