Difference between revisions of "SHIP:Sail:abs"

From Serious Documentation
Jump to: navigation, search
 
(20 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]]
 
−
*{{SailFunc|abs}}, {{SailFunc|min}}, {{SailFunc|max}}, {{SailFunc|round}}, {{SailFunc|ceil}}, {{SailFunc|floor}}, {{SailFunc|itof}}, {{SailFunc|ftoi}}
 
−
== min ==
 
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
−
|{{SailFunc|min}}||{{DataType|Integer}}/{{DataType|Float}}||2+||Gets the minimum value of two or more numbers</onlyinclude>
+
|{{SailFunc|abs}}||{{DataType|Integer}}/{{DataType|Float}}||style="text-align:center;"|v4.0||Gets the absolute value of a number</onlyinclude>
 
|}
 
|}
−
 
+
The {{DataType|Float}} form of 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|ceil}}, {{SailFunc|floor}}, {{SailFunc|ftoi}}, {{SailFunc|itof}}, {{SailFunc|max}}, {{SailFunc|min}}, {{SailFunc|round}}
 
== Prototype ==
 
== Prototype ==
−
<code>{{DataType|Integer}} min({{DataType|Integer}} n1, {{DataType|Integer}} n2);</code>
+
<code>{{DataType|Integer}} {{SailFunc|abs}}({{DataType|Integer}} number);</code>
  
−
<code>{{DataType|Integer}} min({{DataType|Integer}} n1, {{DataType|Integer}} n2, {{DataType|Integer}} n3);</code>
+
<code>{{DataType|Float}} {{SailFunc|abs}}({{DataType|Float}} number);</code>
  
−
<code>{{DataType|Float}} min({{DataType|Integer}}/{{DataType|Float}} n1, {{DataType|Integer}}/{{DataType|Float}} n2);</code>
+
== Parameters/Return Value ==
−
 
 
−
<code>{{DataType|Float}} min({{DataType|Integer}}/{{DataType|Float}} n1, {{DataType|Integer}}/{{DataType|Float}} n2, {{DataType|Integer}}/{{DataType|Float}} n3);</code>
 
−
 
 
−
=== 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 24: Line 20:
 
! scope="col" style="text-align:left" | Description
 
! scope="col" style="text-align:left" | Description
 
|-
 
|-
−
|n1||{{DataType|Integer}}/{{DataType|Float}}||The first of a set of numbers to find the minimum of
+
|number||{{DataType|Integer}}/{{DataType|Float}}||The number to find the absolute value of
−
|-
 
−
|n2||{{DataType|Integer}}/{{DataType|Float}}||The second of a set of numbers to find the minimum of
 
−
|-
 
−
|n3||{{DataType|Integer}}/{{DataType|Float}}||The third of a set of numbers to find the minimum of
 
 
|-
 
|-
 
! scope="col" style="text-align:left" | Return
 
! scope="col" style="text-align:left" | Return
 
! scope="col" style="text-align:left" | {{DataType|Integer}}/{{DataType|Float}}
 
! scope="col" style="text-align:left" | {{DataType|Integer}}/{{DataType|Float}}
−
! scope="col" style="text-align:left" | the minimum 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 absolute value of the supplied number
 
|}
 
|}
−
 
 
== Detailed Description ==
 
== Detailed Description ==
−
 
+
The <code>{{SailFunc|abs}}(number)</code> function returns the absolute value of the specified number.
−
The <code>min()</code> function returns the minimum value of the set of specified numbers.
 
−
 
 
 
== Examples ==
 
== Examples ==
 
{| class="wikitable" style="margin: 1em 1em;"  
 
{| class="wikitable" style="margin: 1em 1em;"  
Line 45: Line 34:
 
! scope="col" style="text-align:left" | Notes
 
! scope="col" style="text-align:left" | Notes
 
|-
 
|-
−
|<code>min(-5,-6);</code> || -6 ||
+
|<source lang="c">abs(-5);</source> || 5 ||
−
|-
 
−
|<code>min(-5, 2, 12);</code> || -5 ||
 
−
|-
 
−
|<code>min(0, 6, 5);</code> || 0 ||
 
−
|}
 
−
 
 
−
 
 
−
*[[SHIP:Sail:min|min()]], [[SHIP:Sail:max|max()]]
 
−
 
 
−
== abs ==
 
−
Gets the absolute value of a number.
 
−
 
 
−
== Prototype ==
 
−
<code>{{DataType|Integer}} abs({{DataType|Integer}} number);</code>
 
−
 
 
−
=== Parameters/Return Value ===
 
−
{| class="wikitable" style="margin: 1em 1em;"
 
−
! scope="col" style="text-align:left" | Parameter
 
−
! scope="col" style="text-align:left" | Data Type
 
−
! scope="col" style="text-align:left" | Description
 
 
|-
 
|-
−
|number||{{DataType|Integer}}||The number to take the absolute value of
+
|<source lang="c">abs(0);</source> || 0 ||
 
|-
 
|-
−
! scope="col" style="text-align:left" | Return
+
|<source lang="c">abs(6);</source> || 6 ||
−
! scope="col" style="text-align:left" | {{DataType|Integer}}
 
−
! scope="col" style="text-align:left" | the absolute value of "number"
 
 
|}
 
|}
  
−
== Detailed Description ==
+
[[Category:Numeric Functions]]
−
 
 
−
The <code>abs(number)</code> function returns the absolute value of the specified number.
 
−
 
 
−
== Examples ==
 
−
{| class="wikitable" style="margin: 1em 1em;"
 
−
! scope="col" style="text-align:left" | Example
 
−
! scope="col" style="text-align:left" | Result
 
−
! scope="col" style="text-align:left" | Notes
 
−
|-
 
−
|<code>abs(-5);</code> || 5 ||
 
−
|-
 
−
|<code>abs(0);</code> || 0 ||
 
−
|-
 
−
|<code>abs(6);</code> || 6 ||
 
−
|}
 

Latest revision as of 14:36, 11 October 2016

Function Returns Introduced Description
abs Integer/Float v4.0 Gets the absolute value of a number

The Float form of this function was introduced in SHIP Version 5.0.

See Also:

Prototype

Integer abs(Integer number);

Float abs(Float number);

Parameters/Return Value

Parameter Data Type Description
number Integer/Float The number to find the absolute value of
Return Integer/Float the absolute value of the supplied number

Detailed Description

The abs(number) function returns the absolute value of the specified number.

Examples

Example Result Notes 
abs(-5);
 5 
abs(0);
 0 
abs(6);
 6
Retrieved from "https://techref.myserious.com/index.php?title=SHIP:Sail:abs&oldid=6020"