jiangchengfeiyi-xiaochengxu/node_modules/mathjs/lib/cjs/function/unit/to.js
2025-01-02 11:13:50 +08:00

52 lines
1.4 KiB
JavaScript

"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.createTo = void 0;
var _factory = require("../../utils/factory.js");
var _matrixAlgorithmSuite = require("../../type/matrix/utils/matrixAlgorithmSuite.js");
const name = 'to';
const dependencies = ['typed', 'matrix', 'concat'];
const createTo = exports.createTo = /* #__PURE__ */(0, _factory.factory)(name, dependencies, _ref => {
let {
typed,
matrix,
concat
} = _ref;
const matrixAlgorithmSuite = (0, _matrixAlgorithmSuite.createMatrixAlgorithmSuite)({
typed,
matrix,
concat
});
/**
* 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
}));
});