Back to FabImage Library website

You are here: Start » Function Reference » All Functions » 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.

Header: STD.h
Namespace: fil
Module: FoundationLite

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
Input value
 inInitialValue const Optional<int>& NIL
Input value
 inArray const Array<int>&
Output value
 outMaximum int&
Output value
 outIndex Optional<Conditional<int>&> NIL

Optional Outputs

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

Read more about Optional Outputs.

Description

Array version of MaximumInteger.

Errors

List of possible exceptions:

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

See Also