jiangchengfeiyi-xiaochengxu/node_modules/mathjs/lib/esm/function/relational/equal.js
2025-01-02 11:13:50 +08:00

111 lines
3.4 KiB
JavaScript

import { factory } from '../../utils/factory.js';
import { createMatAlgo03xDSf } from '../../type/matrix/utils/matAlgo03xDSf.js';
import { createMatAlgo07xSSf } from '../../type/matrix/utils/matAlgo07xSSf.js';
import { createMatAlgo12xSfs } from '../../type/matrix/utils/matAlgo12xSfs.js';
import { createMatrixAlgorithmSuite } from '../../type/matrix/utils/matrixAlgorithmSuite.js';
var name = 'equal';
var dependencies = ['typed', 'matrix', 'equalScalar', 'DenseMatrix', 'concat', 'SparseMatrix'];
export var createEqual = /* #__PURE__ */factory(name, dependencies, _ref => {
var {
typed,
matrix,
equalScalar,
DenseMatrix,
concat,
SparseMatrix
} = _ref;
var matAlgo03xDSf = createMatAlgo03xDSf({
typed
});
var matAlgo07xSSf = createMatAlgo07xSSf({
typed,
SparseMatrix
});
var matAlgo12xSfs = createMatAlgo12xSfs({
typed,
DenseMatrix
});
var matrixAlgorithmSuite = createMatrixAlgorithmSuite({
typed,
matrix,
concat
});
/**
* Test whether two values are equal.
*
* The function tests whether the relative difference between x and y is
* smaller than the configured relTol and absTol. The function cannot be used to
* compare values smaller than approximately 2.22e-16.
*
* For matrices, the function is evaluated element wise.
* In case of complex numbers, x.re must equal y.re, and x.im must equal y.im.
*
* Values `null` and `undefined` are compared strictly, thus `null` is only
* equal to `null` and nothing else, and `undefined` is only equal to
* `undefined` and nothing else. Strings are compared by their numerical value.
*
* Syntax:
*
* math.equal(x, y)
*
* Examples:
*
* math.equal(2 + 2, 3) // returns false
* math.equal(2 + 2, 4) // returns true
*
* const a = math.unit('50 cm')
* const b = math.unit('5 m')
* math.equal(a, b) // returns true
*
* const c = [2, 5, 1]
* const d = [2, 7, 1]
*
* math.equal(c, d) // returns [true, false, true]
* math.deepEqual(c, d) // returns false
*
* math.equal("1000", "1e3") // returns true
* math.equal(0, null) // returns false
*
* See also:
*
* unequal, smaller, smallerEq, larger, largerEq, compare, deepEqual, equalText
*
* @param {number | BigNumber | bigint | boolean | Complex | Unit | string | Array | Matrix} x First value to compare
* @param {number | BigNumber | bigint | boolean | Complex | Unit | string | Array | Matrix} y Second value to compare
* @return {boolean | Array | Matrix} Returns true when the compared values are equal, else returns false
*/
return typed(name, createEqualNumber({
typed,
equalScalar
}), matrixAlgorithmSuite({
elop: equalScalar,
SS: matAlgo07xSSf,
DS: matAlgo03xDSf,
Ss: matAlgo12xSfs
}));
});
export var createEqualNumber = factory(name, ['typed', 'equalScalar'], _ref2 => {
var {
typed,
equalScalar
} = _ref2;
return typed(name, {
'any, any': function any_any(x, y) {
// strict equality for null and undefined?
if (x === null) {
return y === null;
}
if (y === null) {
return x === null;
}
if (x === undefined) {
return y === undefined;
}
if (y === undefined) {
return x === undefined;
}
return equalScalar(x, y);
}
});
});