Difference between revisions of "SHIP:Sail:max"

From Serious Documentation
Jump to: navigation, search
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
See Also:
 
−
*[[SHIP:Sail|SHIP Sail Home]]
 
−
*[[SHIP:Sail:Functions|SHIP Sail Function Home]]
 
−
*[[SHIP:Sail:abs|abs()]], [[SHIP:Sail:min|min()]], [[SHIP:Sail:round|round()]], [[SHIP:Sail:ceil|ceil()]], [[SHIP:Sail:floor|floor()]], [[SHIP:Sail:ftoi|ftoi()]], [[SHIP:Sail:itof|itof()]]
 
−
 
−
== max ==
 
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
−
|{{SailFunc|max}}||{{DataType|Integer}},{{DataType|Float}}||2+||Gets the maximum value of two or more numbers</onlyinclude>
+
|{{SailFunc|max}}||{{DataType|Integer}}/{{DataType|Float}}||style="text-align:center;"|v4.0||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: ==
 +
*[[SHIP:Sail|Sail Home]]
 +
*[[SHIP:Sail:Functions|Sail Functions]]
 +
*[[SHIP:Sail:Numeric Functions|Sail Numeric Functions]]
 +
*{{SailFunc|abs}}, {{SailFunc|ceil}}, {{SailFunc|floor}}, {{SailFunc|ftoi}}, {{SailFunc|itof}}, {{SailFunc|min}}, {{SailFunc|round}}
 
== Prototype ==
 
== Prototype ==
−
<code>{{DataType|Integer}} max({{DataType|Integer}} n1, {{DataType|Integer}} n2);</code>
+
<code>{{DataType|Integer}} {{SailFunc|max}}({{DataType|Integer}} n1, {{DataType|Integer}} n2);</code>
  
−
<code>{{DataType|Integer}} max({{DataType|Integer}} n1, {{DataType|Integer}} n2, {{DataType|Integer}} n3);</code>
+
<code>{{DataType|Integer}} {{SailFunc|max}}({{DataType|Integer}} n1, {{DataType|Integer}} n2, {{DataType|Integer}} n3);</code>
  
−
<code>{{DataType|Float}} max({{DataType|Integer}}/{{DataType|Float}} n1, {{DataType|Integer}}/{{DataType|Float}} n2);</code>
+
<code>{{DataType|Float}} {{SailFunc|max}}({{DataType|Integer}}/{{DataType|Float}} n1, {{DataType|Integer}}/{{DataType|Float}} n2);</code>
  
−
<code>{{DataType|Float}} max({{DataType|Integer}}/{{DataType|Float}} n1, {{DataType|Integer}}/{{DataType|Float}} n2, {{DataType|Integer}}/{{DataType|Float}} n3);</code>
+
<code>{{DataType|Float}} {{SailFunc|max}}({{DataType|Integer}}/{{DataType|Float}} n1, {{DataType|Integer}}/{{DataType|Float}} n2, {{DataType|Integer}}/{{DataType|Float}} n3);</code>
−
=== Parameters/Return Value ===
+
== Parameters/Return Value ==
 
{| class="wikitable" style="margin: 1em 1em;"  
 
{| class="wikitable" style="margin: 1em 1em;"  
 
! scope="col" style="text-align:left" | Parameter
 
! scope="col" style="text-align:left" | Parameter
Line 34: Line 33:
 
! scope="col" style="text-align:left" | the maximum of the supplied numbers; if any parameter is a {{DataType|Float}}, the result will be a {{DataType|Float}}
 
! scope="col" style="text-align:left" | the maximum of the supplied numbers; if any parameter is a {{DataType|Float}}, the result will be a {{DataType|Float}}
 
|}
 
|}
−
 
 
== Detailed Description ==
 
== Detailed Description ==
−
 
+
The <code>{{SailFunc|max}}()</code> function returns the maximum value of the set of specified numbers.
−
The <code>max()</code> function returns the maximum value of the set of specified numbers.
 
−
 
 
 
== Examples ==
 
== Examples ==
 
{| class="wikitable" style="margin: 1em 1em;"  
 
{| class="wikitable" style="margin: 1em 1em;"  
Line 45: Line 41:
 
! scope="col" style="text-align:left" | Notes
 
! scope="col" style="text-align:left" | Notes
 
|-
 
|-
−
|<code>max(-5,-6);</code> || -5 ||
+
|<code>{{SailFunc|max}}(-5,-6);</code> || -5 ||
 
|-
 
|-
−
|<code>max(-5, 2, 12);</code> || 12 ||
+
|<code>{{SailFunc|max}}(-5, 2, 12);</code> || 12 ||
 
|-
 
|-
−
|<code>max(0, 6, -5);</code> || 6 ||
+
|<code>{{SailFunc|max}}(0, 6, -5);</code> || 6 ||
 
|}
 
|}
 +
 +
[[Category:Numeric Functions]]

Latest revision as of 15:15, 10 October 2016

Function Returns Introduced Description
max Integer/Float v4.0 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=5971"