1.0 KiB

Function floor

Round a value towards minus infinity. For matrices, the function is evaluated element wise.

Syntax

math.floor(x)

Parameters

Parameter Type Description
x number | BigNumber | Fraction | Complex | Array | Matrix Number to be rounded

Returns

Type Description
number | BigNumber | Fraction | Complex | Array | Matrix Rounded value

Examples

math.floor(3.2)              // returns number 3
math.floor(3.8)              // returns number 3
math.floor(-4.2)             // returns number -5
math.floor(-4.7)             // returns number -5

const c = math.complex(3.2, -2.7)
math.floor(c)                // returns Complex 3 - 3i

math.floor([3.2, 3.8, -4.7]) // returns Array [3, 3, -5]

See also

ceil, fix, round