Start » Filter Reference » Basic » Real » MaximumDouble_OfArray

MaximumDouble_OfArray

Basic

Module: FoundationLite

Returns the greatest value in an array of double numbers.

Name Type Description
Input value
 inInitialValue Double* Optional initial input Double value
Input value
 inArray DoubleArray Input array of Double values
Output value
 outMaximum Double Output Double value of highest value within inArray; returns inInitialValue if it is higher than any value within array or if array is empty
Output value
 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

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 MaximumDouble_OfArray.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of MaximumDouble_OfArray filter group.