mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-25 15:07:57 +00:00
43 lines
1.2 KiB
JavaScript
43 lines
1.2 KiB
JavaScript
import { factory } from '../../utils/factory.js'
|
|
import { createMatrixAlgorithmSuite } from '../../type/matrix/utils/matrixAlgorithmSuite.js'
|
|
|
|
const name = 'to'
|
|
const dependencies = [
|
|
'typed',
|
|
'matrix'
|
|
]
|
|
|
|
export const createTo = /* #__PURE__ */ factory(name, dependencies, ({ typed, matrix }) => {
|
|
const matrixAlgorithmSuite = createMatrixAlgorithmSuite({ typed, matrix })
|
|
|
|
/**
|
|
* Change the unit of a value.
|
|
*
|
|
* For matrices, the function is evaluated element wise.
|
|
*
|
|
* Syntax:
|
|
*
|
|
* math.to(x, unit)
|
|
*
|
|
* Examples:
|
|
*
|
|
* math.to(math.unit('2 inch'), 'cm') // returns Unit 5.08 cm
|
|
* math.to(math.unit('2 inch'), math.unit('cm')) // returns Unit 5.08 cm
|
|
* math.to(math.unit(16, 'bytes'), 'bits') // returns Unit 128 bits
|
|
*
|
|
* See also:
|
|
*
|
|
* unit
|
|
*
|
|
* @param {Unit | Array | Matrix} x The unit to be converted.
|
|
* @param {Unit | Array | Matrix} unit New unit. Can be a string like "cm"
|
|
* or a unit without value.
|
|
* @return {Unit | Array | Matrix} value with changed, fixed unit.
|
|
*/
|
|
return typed(
|
|
name,
|
|
{ 'Unit, Unit | string': (x, unit) => x.to(unit) },
|
|
matrixAlgorithmSuite({ Ds: true })
|
|
)
|
|
})
|