Back to Aurora Vision Library Lite website
You are here: Start » 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: | avl |
Returns the greatest value in an array of integer numbers.
Syntax
void avl::MaximumInteger_OfArray ( const atl::Optional<int>& inInitialValue, const atl::Array<int>& inArray, int& outMaximum, atl::Optional<atl::Conditional<int>&> outIndex = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inInitialValue | const Optional<int>& | NIL | ||
inArray | const Array<int>& | |||
outMaximum | int& | |||
outIndex | Optional<Conditional<int>&> | NIL |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::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
- MaximumInteger – Returns the higher of two numbers.