simple-squiggle/node_modules/mathjs/docs/reference/functions/floor.md

Function floor

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

Syntax

math.floor(x)
math.floor(x, n)

Parameters

Parameter	Type	Description
x	number | BigNumber | Fraction | Complex | Array | Matrix	Number to be rounded
n	number | BigNumber | Array	Number of decimals Default value: 0.

Returns

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

Throws

Type	Description

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

math.floor(3.212, 2)          // returns number 3.21
math.floor(3.288, 2)          // returns number 3.28
math.floor(-4.212, 2)         // returns number -4.22
math.floor(-4.782, 2)         // returns number -4.79

const c = math.complex(3.24, -2.71)
math.floor(c)                 // returns Complex 3 - 3i
math.floor(c, 1)              // returns Complex 3.2 - 2.8i

math.floor([3.2, 3.8, -4.7])       // returns Array [3, 3, -5]
math.floor([3.21, 3.82, -4.71], 1)  // returns Array [3.2, 3.8, -4.8]

See also

ceil, fix, round