mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-18 14:59:29 +00:00
53 lines
1.3 KiB
Markdown
53 lines
1.3 KiB
Markdown
# Function round
|
|
|
|
Round a value towards the nearest integer.
|
|
For matrices, the function is evaluated element wise.
|
|
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
math.round(x)
|
|
math.round(x, n)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Parameter | Type | Description
|
|
--------- | ---- | -----------
|
|
`x` | Number | BigNumber | Boolean | Complex | Array | Matrix | null | Number to be rounded
|
|
`n` | Number | BigNumber | Boolean | Array | null | Number of decimals Default value: 0.
|
|
|
|
### Returns
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
Number | BigNumber | Complex | Array | Matrix | Rounded value
|
|
|
|
|
|
## Examples
|
|
|
|
```js
|
|
math.round(3.2); // returns Number 3
|
|
math.round(3.8); // returns Number 4
|
|
math.round(-4.2); // returns Number -4
|
|
math.round(-4.7); // returns Number -5
|
|
math.round(math.pi, 3); // returns Number 3.142
|
|
math.round(123.45678, 2); // returns Number 123.46
|
|
|
|
var c = math.complex(3.2, -2.7);
|
|
math.round(c); // returns Complex 3 - 3i
|
|
|
|
math.round([3.2, 3.8, -4.7]); // returns Array [3, 4, -5]
|
|
```
|
|
|
|
|
|
## See also
|
|
|
|
[ceil](ceil.md),
|
|
[fix](fix.md),
|
|
[floor](floor.md)
|
|
|
|
|
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|