1 |
|
2 |
|
3 | # Function floor
|
4 |
|
5 | Round a value towards minus infinity.
|
6 | For matrices, the function is evaluated element wise.
|
7 |
|
8 |
|
9 | ## Syntax
|
10 |
|
11 | ```js
|
12 | math.floor(x)
|
13 | math.floor(x, n)
|
14 | ```
|
15 |
|
16 | ### Parameters
|
17 |
|
18 | Parameter | Type | Description
|
19 | --------- | ---- | -----------
|
20 | `x` | number | BigNumber | Fraction | Complex | Array | Matrix | Number to be rounded
|
21 | `n` | number | BigNumber | Array | Number of decimals Default value: 0.
|
22 |
|
23 | ### Returns
|
24 |
|
25 | Type | Description
|
26 | ---- | -----------
|
27 | number | BigNumber | Fraction | Complex | Array | Matrix | Rounded value
|
28 |
|
29 |
|
30 | ## Examples
|
31 |
|
32 | ```js
|
33 | math.floor(3.2) // returns number 3
|
34 | math.floor(3.8) // returns number 3
|
35 | math.floor(-4.2) // returns number -5
|
36 | math.floor(-4.7) // returns number -5
|
37 |
|
38 | math.floor(3.212, 2) // returns number 3.21
|
39 | math.floor(3.288, 2) // returns number 3.28
|
40 | math.floor(-4.212, 2) // returns number -4.22
|
41 | math.floor(-4.782, 2) // returns number -4.79
|
42 |
|
43 | const c = math.complex(3.24, -2.71)
|
44 | math.floor(c) // returns Complex 3 - 3i
|
45 | math.floor(c, 1) // returns Complex 3.2 - 2.8i
|
46 |
|
47 | math.floor([3.2, 3.8, -4.7]) // returns Array [3, 3, -5]
|
48 | math.floor([3.21, 3.82, -4.71], 1) // returns Array [3.2, 3.8, -4.8]
|
49 | ```
|
50 |
|
51 |
|
52 | ## See also
|
53 |
|
54 | [ceil](ceil.md),
|
55 | [fix](fix.md),
|
56 | [round](round.md)
|