1 |
|
2 |
|
3 | # Function round
|
4 |
|
5 | Round a value towards the nearest integer.
|
6 | For matrices, the function is evaluated element wise.
|
7 |
|
8 |
|
9 | ## Syntax
|
10 |
|
11 | ```js
|
12 | math.round(x)
|
13 | math.round(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.round(3.22) // returns number 3
|
34 | math.round(3.82) // returns number 4
|
35 | math.round(-4.2) // returns number -4
|
36 | math.round(-4.7) // returns number -5
|
37 | math.round(3.22, 1) // returns number 3.2
|
38 | math.round(3.88, 1) // returns number 3.9
|
39 | math.round(-4.21, 1) // returns number -4.2
|
40 | math.round(-4.71, 1) // returns number -4.7
|
41 | math.round(math.pi, 3) // returns number 3.142
|
42 | math.round(123.45678, 2) // returns number 123.46
|
43 |
|
44 | const c = math.complex(3.2, -2.7)
|
45 | math.round(c) // returns Complex 3 - 3i
|
46 |
|
47 | math.round([3.2, 3.8, -4.7]) // returns Array [3, 4, -5]
|
48 | ```
|
49 |
|
50 |
|
51 | ## See also
|
52 |
|
53 | [ceil](ceil.md),
|
54 | [fix](fix.md),
|
55 | [floor](floor.md)
|