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
242 lines (239 loc) • 8.99 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.createRound = void 0;
var _factory = require("../../utils/factory.js");
var _collection = require("../../utils/collection.js");
var _number = require("../../utils/number.js");
var _nearlyEqual = require("../../utils/bignumber/nearlyEqual.js");
var _matAlgo11xS0s = require("../../type/matrix/utils/matAlgo11xS0s.js");
var _matAlgo12xSfs = require("../../type/matrix/utils/matAlgo12xSfs.js");
var _matAlgo14xDs = require("../../type/matrix/utils/matAlgo14xDs.js");
var _index = require("../../plain/number/index.js");
var NO_INT = 'Number of decimals in function round must be an integer';
var name = 'round';
var dependencies = ['typed', 'config', 'matrix', 'equalScalar', 'zeros', 'BigNumber', 'DenseMatrix'];
var createRound = exports.createRound = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
var typed = _ref.typed,
config = _ref.config,
matrix = _ref.matrix,
equalScalar = _ref.equalScalar,
zeros = _ref.zeros,
_BigNumber = _ref.BigNumber,
DenseMatrix = _ref.DenseMatrix;
var matAlgo11xS0s = (0, _matAlgo11xS0s.createMatAlgo11xS0s)({
typed: typed,
equalScalar: equalScalar
});
var matAlgo12xSfs = (0, _matAlgo12xSfs.createMatAlgo12xSfs)({
typed: typed,
DenseMatrix: DenseMatrix
});
var matAlgo14xDs = (0, _matAlgo14xDs.createMatAlgo14xDs)({
typed: typed
});
function toExponent(epsilon) {
return Math.abs((0, _number.splitNumber)(epsilon).exponent);
}
/**
* Round a value towards the nearest rounded value.
* For matrices, the function is evaluated element wise.
*
* Syntax:
*
* math.round(x)
* math.round(x, n)
* math.round(unit, valuelessUnit)
* math.round(unit, n, valuelessUnit)
*
* Examples:
*
* math.round(3.22) // returns number 3
* math.round(3.82) // returns number 4
* math.round(-4.2) // returns number -4
* math.round(-4.7) // returns number -5
* math.round(3.22, 1) // returns number 3.2
* math.round(3.88, 1) // returns number 3.9
* math.round(-4.21, 1) // returns number -4.2
* math.round(-4.71, 1) // returns number -4.7
* math.round(math.pi, 3) // returns number 3.142
* math.round(123.45678, 2) // returns number 123.46
*
* const c = math.complex(3.2, -2.7)
* math.round(c) // returns Complex 3 - 3i
*
* const unit = math.unit('3.241 cm')
* const cm = math.unit('cm')
* const mm = math.unit('mm')
* math.round(unit, 1, cm) // returns Unit 3.2 cm
* math.round(unit, 1, mm) // returns Unit 32.4 mm
*
* math.round([3.2, 3.8, -4.7]) // returns Array [3, 4, -5]
*
* See also:
*
* ceil, fix, floor
*
* @param {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} x Value to be rounded
* @param {number | BigNumber | Array} [n=0] Number of decimals
* @param {Unit} [valuelessUnit] A valueless unit
* @return {number | BigNumber | Fraction | Complex | Array | Matrix} Rounded value
*/
return typed(name, {
number: function number(x) {
// Handle round off errors by first rounding to epsilon precision
var xEpsilon = (0, _index.roundNumber)(x, toExponent(config.epsilon));
var xSelected = (0, _number.nearlyEqual)(x, xEpsilon, config.epsilon) ? xEpsilon : x;
return (0, _index.roundNumber)(xSelected);
},
'number, number': function numberNumber(x, n) {
// Same as number: unless user specifies more decimals than epsilon
var epsilonExponent = toExponent(config.epsilon);
if (n >= epsilonExponent) {
return (0, _index.roundNumber)(x, n);
}
var xEpsilon = (0, _index.roundNumber)(x, epsilonExponent);
var xSelected = (0, _number.nearlyEqual)(x, xEpsilon, config.epsilon) ? xEpsilon : x;
return (0, _index.roundNumber)(xSelected, n);
},
'number, BigNumber': function numberBigNumber(x, n) {
if (!n.isInteger()) {
throw new TypeError(NO_INT);
}
return new _BigNumber(x).toDecimalPlaces(n.toNumber());
},
Complex: function Complex(x) {
return x.round();
},
'Complex, number': function ComplexNumber(x, n) {
if (n % 1) {
throw new TypeError(NO_INT);
}
return x.round(n);
},
'Complex, BigNumber': function ComplexBigNumber(x, n) {
if (!n.isInteger()) {
throw new TypeError(NO_INT);
}
var _n = n.toNumber();
return x.round(_n);
},
BigNumber: function BigNumber(x) {
// Handle round off errors by first rounding to epsilon precision
var xEpsilon = new _BigNumber(x).toDecimalPlaces(toExponent(config.epsilon));
var xSelected = (0, _nearlyEqual.nearlyEqual)(x, xEpsilon, config.epsilon) ? xEpsilon : x;
return xSelected.toDecimalPlaces(0);
},
'BigNumber, BigNumber': function BigNumberBigNumber(x, n) {
if (!n.isInteger()) {
throw new TypeError(NO_INT);
}
// Same as BigNumber: unless user specifies more decimals than epsilon
var epsilonExponent = toExponent(config.epsilon);
if (n >= epsilonExponent) {
return x.toDecimalPlaces(n.toNumber());
}
var xEpsilon = x.toDecimalPlaces(epsilonExponent);
var xSelected = (0, _nearlyEqual.nearlyEqual)(x, xEpsilon, config.epsilon) ? xEpsilon : x;
return xSelected.toDecimalPlaces(n.toNumber());
},
Fraction: function Fraction(x) {
return x.round();
},
'Fraction, number': function FractionNumber(x, n) {
if (n % 1) {
throw new TypeError(NO_INT);
}
return x.round(n);
},
'Fraction, BigNumber': function FractionBigNumber(x, n) {
if (!n.isInteger()) {
throw new TypeError(NO_INT);
}
return x.round(n.toNumber());
},
'Unit, number, Unit': typed.referToSelf(function (self) {
return function (x, n, unit) {
var valueless = x.toNumeric(unit);
return unit.multiply(self(valueless, n));
};
}),
'Unit, BigNumber, Unit': typed.referToSelf(function (self) {
return function (x, n, unit) {
return self(x, n.toNumber(), unit);
};
}),
'Unit, Unit': typed.referToSelf(function (self) {
return function (x, unit) {
return self(x, 0, unit);
};
}),
'Array | Matrix, number, Unit': typed.referToSelf(function (self) {
return function (x, n, unit) {
// deep map collection, skip zeros since round(0) = 0
return (0, _collection.deepMap)(x, function (value) {
return self(value, n, unit);
}, true);
};
}),
'Array | Matrix, BigNumber, Unit': typed.referToSelf(function (self) {
return function (x, n, unit) {
return self(x, n.toNumber(), unit);
};
}),
'Array | Matrix, Unit': typed.referToSelf(function (self) {
return function (x, unit) {
return self(x, 0, unit);
};
}),
'Array | Matrix': typed.referToSelf(function (self) {
return function (x) {
// deep map collection, skip zeros since round(0) = 0
return (0, _collection.deepMap)(x, self, true);
};
}),
'SparseMatrix, number | BigNumber': typed.referToSelf(function (self) {
return function (x, n) {
return matAlgo11xS0s(x, n, self, false);
};
}),
'DenseMatrix, number | BigNumber': typed.referToSelf(function (self) {
return function (x, n) {
return matAlgo14xDs(x, n, self, false);
};
}),
'Array, number | BigNumber': typed.referToSelf(function (self) {
return function (x, n) {
// use matrix implementation
return matAlgo14xDs(matrix(x), n, self, false).valueOf();
};
}),
'number | Complex | BigNumber | Fraction, SparseMatrix': typed.referToSelf(function (self) {
return function (x, n) {
// check scalar is zero
if (equalScalar(x, 0)) {
// do not execute algorithm, result will be a zero matrix
return zeros(n.size(), n.storage());
}
return matAlgo12xSfs(n, x, self, true);
};
}),
'number | Complex | BigNumber | Fraction, DenseMatrix': typed.referToSelf(function (self) {
return function (x, n) {
// check scalar is zero
if (equalScalar(x, 0)) {
// do not execute algorithm, result will be a zero matrix
return zeros(n.size(), n.storage());
}
return matAlgo14xDs(n, x, self, true);
};
}),
'number | Complex | BigNumber | Fraction, Array': typed.referToSelf(function (self) {
return function (x, n) {
// use matrix implementation
return matAlgo14xDs(matrix(n), x, self, true).valueOf();
};
})
});
});