Start » Filter Reference » Basic » Real » MaximumReal_OfArray
Module: | FoundationLite |
---|
Returns the greatest value in an array of real numbers.
Name | Type | Description | |
---|---|---|---|
inInitialValue | Real* | Optional initial input Real value | |
inArray | RealArray | Input array of Real values | |
outMaximum | Real | Output Real value of highest value within inArray; returns inInitialValue if it is higher than any value within array or if array is empty | |
outIndex | Integer? | Conditional output Integer index value of highest value within inArray; returns Nil if inInitialValue is higher than any value within array or if array is empty |
Description
Array version of MaximumReal.
Hints
- This is a primitive mathematical filter. It is recommended to use Formula Blocks instead.
Errors
This filter can throw an exception to report error. Read how to deal with errors in Error Handling.
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Input array is empty and inInitialValue isn't set in MaximumReal_OfArray. |
Complexity Level
This filter is available on Basic Complexity Level.
Filter Group
This filter is member of MaximumReal_OfArray filter group.
See Also
- MaximumReal – Returns the higher of two numbers.