Difference between revisions of "SHIP:Sail:max"

From Serious Documentation
Jump to: navigation, search
Line 5: Line 5:
 
The ability to use {{DataType|Float}}s with this function was introduced in [[SHIP_Version_5|SHIP Version 5.0]].
 
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|Sail Home]]
−
*[[SHIP:Sail:Functions|SHIP Sail Function Home]]
+
*[[SHIP:Sail:Functions|Sail Functions]]
−
*{{SailFunc|abs}}, {{SailFunc|ceil}}, {{SailFunc|floor}}, {{SailFunc|ftoi}}, {{SailFunc|itof}}, {{SailFunc|max}}, {{SailFunc|min}}, {{SailFunc|round}}
+
*[[SHIP:Sail:Functions|Sail Numeric Functions]]
 +
*{{SailFunc|abs}}, {{SailFunc|ceil}}, {{SailFunc|floor}}, {{SailFunc|ftoi}}, {{SailFunc|itof}}, {{SailFunc|min}}, {{SailFunc|round}}
 
== Prototype ==
 
== Prototype ==
 
<code>{{DataType|Integer}} {{SailFunc|max}}({{DataType|Integer}} n1, {{DataType|Integer}} n2);</code>
 
<code>{{DataType|Integer}} {{SailFunc|max}}({{DataType|Integer}} n1, {{DataType|Integer}} n2);</code>

Revision as of 08:21, 13 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
Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Sail:max&oldid=4167"