Difference between revisions of "SHIP:Sail:round"

From Serious Documentation
Jump to: navigation, search
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
|{{SailFunc|round}}||{{DataType|Integer}}||1||Gets the nearest integer to a number {{v5}}</onlyinclude>
+
|{{SailFunc|round}}||{{DataType|Integer}}||style="text-align:center;"|v5.0||Gets the nearest integer to a number</onlyinclude>
 
|}
 
|}
This function was introduced in [[SHIP_Version_5|SHIP Version 5.0]].
 
 
== See Also: ==
 
== See Also: ==
 
*[[SHIP:Sail|Sail Home]]
 
*[[SHIP:Sail|Sail Home]]
 
*[[SHIP:Sail:Functions|Sail Functions]]
 
*[[SHIP:Sail:Functions|Sail Functions]]
*[[SHIP:Sail:Functions|Sail Numeric Functions]]
+
*[[SHIP:Sail:Numeric Functions|Sail Numeric Functions]]
 
*{{SailFunc|abs}}, {{SailFunc|ceil}}, {{SailFunc|floor}}, {{SailFunc|ftoi}}, {{SailFunc|itof}}, {{SailFunc|max}}, {{SailFunc|min}}
 
*{{SailFunc|abs}}, {{SailFunc|ceil}}, {{SailFunc|floor}}, {{SailFunc|ftoi}}, {{SailFunc|itof}}, {{SailFunc|max}}, {{SailFunc|min}}
 
== Prototype ==
 
== Prototype ==
Line 43: Line 42:
 
|<code>{{SailFunc|round}}(5.5f);</code> || 6 ||
 
|<code>{{SailFunc|round}}(5.5f);</code> || 6 ||
 
|}
 
|}
 +
 +
[[Category: Numeric Functions]]

Latest revision as of 16:08, 26 October 2016

Function Returns Introduced Description
round Integer v5.0 Gets the nearest integer to a number

See Also:

Prototype

Integer round(Float n);

Parameters/Return Value

Parameter Data Type Description
n Float the number to find the rounded value of
Return Integer the rounded value of the supplied number

Detailed Description

The round() function returns the nearest integer to a number.

Examples

Example Result Notes
round(-5.1f); -5
round(-5.5f); -6
round(5.2f); 5
round(5.5f); 6