Difference between revisions of "SHIP:Sail:max"

From Serious Documentation
Jump to: navigation, search
Line 3: Line 3:
 
|{{SailFunc|max}}||{{DataType|Integer}},{{DataType|Float}}||2+||Gets the maximum value of two or more numbers</onlyinclude>
 
|{{SailFunc|max}}||{{DataType|Integer}},{{DataType|Float}}||2+||Gets the maximum value of two or more numbers</onlyinclude>
 
|}
 
|}
 +
The ability to use {{DataType|Float}}s with this function was introduced in [[SHIP_Version_5|SHIP Version 5.0]].
 
== See Also: ==
 
== See Also: ==
 
*[[SHIP:Sail|SHIP Sail Home]]
 
*[[SHIP:Sail|SHIP Sail Home]]

Revision as of 04:36, 9 July 2014

Function Returns Introduced Description
max Integer,Float 2+ Gets the maximum value of two or more numbers

The ability to use Floats with this function was introduced in SHIP Version 5.0.

See Also:

Prototype

Integer max(Integer n1, Integer n2);

Integer max(Integer n1, Integer n2, Integer n3);

Float max(Integer/Float n1, Integer/Float n2);

Float max(Integer/Float n1, Integer/Float n2, Integer/Float n3);

Parameters/Return Value

Parameter Data Type Description
n1 Integer/Float The first of a set of numbers to find the maximum of
n2 Integer/Float The second of a set of numbers to find the maximum of
n3 Integer/Float The third of a set of numbers to find the maximum of
Return Integer/Float the maximum of the supplied numbers; if any parameter is a Float, the result will be a Float

Detailed Description

The max() function returns the maximum value of the set of specified numbers.

Examples

Example Result Notes
max(-5,-6); -5
max(-5, 2, 12); 12
max(0, 6, -5); 6