Difference between revisions of "SHIP:Sail:floor"

From Serious Documentation
Jump to: navigation, search
(Parameters/Return Value)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
|{{SailFunc|floor}}||{{DataType|Integer}}||1||Gets the largest integer less than or equal to a number</onlyinclude>
+
|{{SailFunc|floor}}||{{DataType|Integer}}||1||Gets the largest integer less than or equal to a number< (v5)</onlyinclude>
 
|}
 
|}
 +
This function was introduced in SHIP Version 5.0.
 
== See Also ==
 
== See Also ==
 
*[[SHIP:Sail|SHIP Sail Home]]
 
*[[SHIP:Sail|SHIP Sail Home]]

Revision as of 06:44, 22 June 2014

Function Returns Introduced Description
floor Integer 1 Gets the largest integer less than or equal to a number< (v5)

This function was introduced in SHIP Version 5.0.

See Also

Prototype

Integer floor(Float n);

Parameters/Return Value

Parameter Data Type Description
n Float the number to find the floor value of
Return Integer the floor (lower) of the supplied number

Detailed Description

The floor() function returns the returns the largest integer less than or equal to a number. If you visualize a number line, floor() goes to the integer to the left.

Examples

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