UNPKG

1.47 kBMarkdownView Raw
1<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
2
3# Function round
4
5Round a value towards the nearest integer.
6For matrices, the function is evaluated element wise.
7
8
9## Syntax
10
11```js
12math.round(x)
13math.round(x, n)
14```
15
16### Parameters
17
18Parameter | Type | Description
19--------- | ---- | -----------
20`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix | Number to be rounded
21`n` | number &#124; BigNumber &#124; Array | Number of decimals Default value: 0.
22
23### Returns
24
25Type | Description
26---- | -----------
27number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix | Rounded value
28
29
30## Examples
31
32```js
33math.round(3.22) // returns number 3
34math.round(3.82) // returns number 4
35math.round(-4.2) // returns number -4
36math.round(-4.7) // returns number -5
37math.round(3.22, 1) // returns number 3.2
38math.round(3.88, 1) // returns number 3.9
39math.round(-4.21, 1) // returns number -4.2
40math.round(-4.71, 1) // returns number -4.7
41math.round(math.pi, 3) // returns number 3.142
42math.round(123.45678, 2) // returns number 123.46
43
44const c = math.complex(3.2, -2.7)
45math.round(c) // returns Complex 3 - 3i
46
47math.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)