50 lines
1.2 KiB
Markdown
50 lines
1.2 KiB
Markdown
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
||
|
|
|
||
|
|
# Function number
|
||
|
|
|
||
|
|
Create a number or convert a string, boolean, or unit to a number.
|
||
|
|
When value is a matrix, all elements will be converted to number.
|
||
|
|
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.number(value)
|
||
|
|
math.number(unit, valuelessUnit)
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Parameter | Type | Description
|
||
|
|
--------- | ---- | -----------
|
||
|
|
`value` | string | number | BigNumber | Fraction | boolean | Array | Matrix | Unit | null | Value to be converted
|
||
|
|
`valuelessUnit` | Unit | string | A valueless unit, used to convert a unit to a number
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
number | Array | Matrix | The created number
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.number(2) // returns number 2
|
||
|
|
math.number('7.2') // returns number 7.2
|
||
|
|
math.number(true) // returns number 1
|
||
|
|
math.number([true, false, true, true]) // returns [1, 0, 1, 1]
|
||
|
|
math.number(math.unit('52cm'), 'm') // returns 0.52
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
[bignumber](bignumber.md),
|
||
|
|
[boolean](boolean.md),
|
||
|
|
[complex](complex.md),
|
||
|
|
[index](index.md),
|
||
|
|
[matrix](matrix.md),
|
||
|
|
[string](string.md),
|
||
|
|
[unit](unit.md)
|