mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-25 15:07:57 +00:00
80 lines
2.4 KiB
Markdown
80 lines
2.4 KiB
Markdown
---
|
|
layout: default
|
|
---
|
|
|
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
|
|
|
<h1 id="function-floor">Function floor <a href="#function-floor" title="Permalink">#</a></h1>
|
|
|
|
Round a value towards minus infinity.
|
|
For matrices, the function is evaluated element wise.
|
|
|
|
|
|
<h2 id="syntax">Syntax <a href="#syntax" title="Permalink">#</a></h2>
|
|
|
|
```js
|
|
math.floor(x)
|
|
math.floor(x, n)
|
|
math.floor(unit, valuelessUnit)
|
|
math.floor(unit, n, valuelessUnit)
|
|
```
|
|
|
|
<h3 id="parameters">Parameters <a href="#parameters" title="Permalink">#</a></h3>
|
|
|
|
Parameter | Type | Description
|
|
--------- | ---- | -----------
|
|
`x` | number | BigNumber | Fraction | Complex | Unit | Array | Matrix | Value to be rounded
|
|
`n` | number | BigNumber | Array | Number of decimals Default value: 0.
|
|
`valuelessUnit` | Unit | A valueless unit
|
|
|
|
<h3 id="returns">Returns <a href="#returns" title="Permalink">#</a></h3>
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
number | BigNumber | Fraction | Complex | Unit | Array | Matrix | Rounded value
|
|
|
|
|
|
<h3 id="throws">Throws <a href="#throws" title="Permalink">#</a></h3>
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
|
|
|
|
<h2 id="examples">Examples <a href="#examples" title="Permalink">#</a></h2>
|
|
|
|
```js
|
|
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
|
|
|
|
const unit = math.unit('3.241 cm')
|
|
const cm = math.unit('cm')
|
|
const mm = math.unit('mm')
|
|
math.floor(unit, 1, cm) // returns Unit 3.2 cm
|
|
math.floor(unit, 1, mm) // returns Unit 32.4 mm
|
|
|
|
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]
|
|
|
|
math.floor(math.tau, [2, 3]) // returns Array [6.28, 6.283]
|
|
|
|
// Note that floor(array, array) currently not implemented.
|
|
```
|
|
|
|
|
|
<h2 id="see-also">See also <a href="#see-also" title="Permalink">#</a></h2>
|
|
|
|
[ceil](ceil.html),
|
|
[fix](fix.html),
|
|
[round](round.html)
|