mathjs
Version:
Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with dif
42 lines (25 loc) • 919 B
Markdown
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
# Function to
Change the unit of a value.
For matrices, the function is evaluated element wise.
## Syntax
```js
math.to(x, unit)
```
### Parameters
Parameter | Type | Description
--------- | ---- | -----------
`x` | Unit | Array | Matrix | The unit to be converted.
`unit` | Unit | Array | Matrix | New unit. Can be a string like "cm" or a unit without value.
### Returns
Type | Description
---- | -----------
Unit | Array | Matrix | value with changed, fixed unit.
## Examples
```js
math.to(math.unit('2 inch'), 'cm') // returns Unit 5.08 cm
math.to(math.unit('2 inch'), math.unit(null, 'cm')) // returns Unit 5.08 cm
math.to(math.unit(16, 'bytes'), 'bits') // returns Unit 128 bits
```
## See also
[unit](unit.md)