jiangchengfeiyi-xiaochengxu/node_modules/mathjs/lib/esm/function/arithmetic/floor.js
2025-04-05 16:12:09 +08:00

198 lines
7.2 KiB
JavaScript

import Decimal from 'decimal.js';
import { factory } from '../../utils/factory.js';
import { deepMap } from '../../utils/collection.js';
import { isInteger, nearlyEqual } from '../../utils/number.js';
import { nearlyEqual as bigNearlyEqual } from '../../utils/bignumber/nearlyEqual.js';
import { createMatAlgo11xS0s } from '../../type/matrix/utils/matAlgo11xS0s.js';
import { createMatAlgo12xSfs } from '../../type/matrix/utils/matAlgo12xSfs.js';
import { createMatAlgo14xDs } from '../../type/matrix/utils/matAlgo14xDs.js';
var name = 'floor';
var dependencies = ['typed', 'config', 'round', 'matrix', 'equalScalar', 'zeros', 'DenseMatrix'];
var bigTen = new Decimal(10);
export var createFloorNumber = /* #__PURE__ */factory(name, ['typed', 'config', 'round'], _ref => {
var {
typed,
config,
round
} = _ref;
function _floorNumber(x) {
// First, if the floor and the round are identical we can be
// quite comfortable that is the best answer:
var f = Math.floor(x);
var r = round(x);
if (f === r) return f;
// OK, they are different. If x is truly distinct from f but
// appears indistinguishable from r, presume it really is just
// the integer r with rounding/computation error, and return that
if (nearlyEqual(x, r, config.relTol, config.absTol) && !nearlyEqual(x, f, config.relTol, config.absTol)) {
return r;
}
// Otherwise (x distinct from both r and f, or indistinguishable from
// both r and f) may as well just return f, as that's the best
// candidate we can discern:
return f;
}
return typed(name, {
number: _floorNumber,
'number, number': function number_number(x, n) {
if (!isInteger(n)) {
throw new RangeError('number of decimals in function floor must be an integer');
}
if (n < 0 || n > 15) {
throw new RangeError('number of decimals in floor number must be in range 0 - 15');
}
var shift = 10 ** n;
return _floorNumber(x * shift) / shift;
}
});
});
export var createFloor = /* #__PURE__ */factory(name, dependencies, _ref2 => {
var {
typed,
config,
round,
matrix,
equalScalar,
zeros,
DenseMatrix
} = _ref2;
var matAlgo11xS0s = createMatAlgo11xS0s({
typed,
equalScalar
});
var matAlgo12xSfs = createMatAlgo12xSfs({
typed,
DenseMatrix
});
var matAlgo14xDs = createMatAlgo14xDs({
typed
});
var floorNumber = createFloorNumber({
typed,
config,
round
});
function _bigFloor(x) {
// see _floorNumber above for rationale
var bne = (a, b) => bigNearlyEqual(a, b, config.relTol, config.absTol);
var f = x.floor();
var r = round(x);
if (f.eq(r)) return f;
if (bne(x, r) && !bne(x, f)) return r;
return f;
}
/**
* Round a value towards minus infinity.
* For matrices, the function is evaluated element wise.
*
* Syntax:
*
* math.floor(x)
* math.floor(x, n)
* math.floor(unit, valuelessUnit)
* math.floor(unit, n, valuelessUnit)
*
* Examples:
*
* math.floor(3.2) // returns number 3
* math.floor(3.8) // returns number 3
* math.floor(-4.2) // returns number -5
* math.floor(-4.7) // returns number -5
*
* math.floor(3.212, 2) // returns number 3.21
* math.floor(3.288, 2) // returns number 3.28
* math.floor(-4.212, 2) // returns number -4.22
* math.floor(-4.782, 2) // returns number -4.79
*
* const c = math.complex(3.24, -2.71)
* math.floor(c) // returns Complex 3 - 3i
* math.floor(c, 1) // returns Complex 3.2 -2.8i
*
* const unit = math.unit('3.241 cm')
* const cm = math.unit('cm')
* const mm = math.unit('mm')
* math.floor(unit, 1, cm) // returns Unit 3.2 cm
* math.floor(unit, 1, mm) // returns Unit 32.4 mm
*
* math.floor([3.2, 3.8, -4.7]) // returns Array [3, 3, -5]
* math.floor([3.21, 3.82, -4.71], 1) // returns Array [3.2, 3.8, -4.8]
*
* math.floor(math.tau, [2, 3]) // returns Array [6.28, 6.283]
*
* // Note that floor(array, array) currently not implemented.
*
* See also:
*
* ceil, fix, round
*
* @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 | Unit | Array | Matrix} Rounded value
*/
return typed('floor', {
number: floorNumber.signatures.number,
'number,number': floorNumber.signatures['number,number'],
Complex: function Complex(x) {
return x.floor();
},
'Complex, number': function Complex_number(x, n) {
return x.floor(n);
},
'Complex, BigNumber': function Complex_BigNumber(x, n) {
return x.floor(n.toNumber());
},
BigNumber: _bigFloor,
'BigNumber, BigNumber': function BigNumber_BigNumber(x, n) {
var shift = bigTen.pow(n);
return _bigFloor(x.mul(shift)).div(shift);
},
bigint: b => b,
'bigint, number': (b, _dummy) => b,
'bigint, BigNumber': (b, _dummy) => b,
Fraction: function Fraction(x) {
return x.floor();
},
'Fraction, number': function Fraction_number(x, n) {
return x.floor(n);
},
'Fraction, BigNumber': function Fraction_BigNumber(x, n) {
return x.floor(n.toNumber());
},
'Unit, number, Unit': typed.referToSelf(self => function (x, n, unit) {
var valueless = x.toNumeric(unit);
return unit.multiply(self(valueless, n));
}),
'Unit, BigNumber, Unit': typed.referToSelf(self => (x, n, unit) => self(x, n.toNumber(), unit)),
'Array | Matrix, number | BigNumber, Unit': typed.referToSelf(self => (x, n, unit) => {
// deep map collection, skip zeros since floor(0) = 0
return deepMap(x, value => self(value, n, unit), true);
}),
'Array | Matrix | Unit, Unit': typed.referToSelf(self => (x, unit) => self(x, 0, unit)),
'Array | Matrix': typed.referToSelf(self => x => {
// deep map collection, skip zeros since floor(0) = 0
return deepMap(x, self, true);
}),
'Array, number | BigNumber': typed.referToSelf(self => (x, n) => {
// deep map collection, skip zeros since ceil(0) = 0
return deepMap(x, i => self(i, n), true);
}),
'SparseMatrix, number | BigNumber': typed.referToSelf(self => (x, y) => {
return matAlgo11xS0s(x, y, self, false);
}),
'DenseMatrix, number | BigNumber': typed.referToSelf(self => (x, y) => {
return matAlgo14xDs(x, y, self, false);
}),
'number | Complex | Fraction | BigNumber, Array': typed.referToSelf(self => (x, y) => {
// use matrix implementation
return matAlgo14xDs(matrix(y), x, self, true).valueOf();
}),
'number | Complex | Fraction | BigNumber, Matrix': typed.referToSelf(self => (x, y) => {
if (equalScalar(x, 0)) return zeros(y.size(), y.storage());
if (y.storage() === 'dense') {
return matAlgo14xDs(y, x, self, true);
}
return matAlgo12xSfs(y, x, self, true);
})
});
});