simple-squiggle/node_modules/mathjs/lib/esm/function/algebra/symbolicEqual.js

80 lines
3.0 KiB
JavaScript

import { isConstantNode } from '../../utils/is.js';
import { factory } from '../../utils/factory.js';
var name = 'symbolicEqual';
var dependencies = ['parse', 'simplify', 'typed', 'OperatorNode'];
export var createSymbolicEqual = /* #__PURE__ */factory(name, dependencies, _ref => {
var {
parse,
simplify,
typed,
OperatorNode
} = _ref;
/**
* Attempts to determine if two expressions are symbolically equal, i.e.
* one is the result of valid algebraic manipulations on the other.
* Currently, this simply checks if the difference of the two expressions
* simplifies down to 0. So there are two important caveats:
* 1. whether two expressions are symbolically equal depends on the
* manipulations allowed. Therefore, this function takes an optional
* third argument, which are the options that control the behavior
* as documented for the `simplify()` function.
* 2. it is in general intractable to find the minimal simplification of
* an arbitrarily complicated expression. So while a `true` value
* of `symbolicEqual` ensures that the two expressions can be manipulated
* to match each other, a `false` value does not absolutely rule this out.
*
* Syntax:
*
* symbolicEqual(expr1, expr2)
* symbolicEqual(expr1, expr2, options)
*
* Examples:
*
* symbolicEqual('x*y', 'y*x') // true
* symbolicEqual('x*y', 'y*x', {context: {multiply: {commutative: false}}})
* //false
* symbolicEqual('x/y', '(y*x^(-1))^(-1)') // true
* symbolicEqual('abs(x)','x') // false
* symbolicEqual('abs(x)','x', simplify.positiveContext) // true
*
* See also:
*
* simplify, evaluate
*
* @param {Node|string} expr1 The first expression to compare
* @param {Node|string} expr2 The second expression to compare
* @param {Object} [options] Optional option object, passed to simplify
* @returns {boolean}
* Returns true if a valid manipulation making the expressions equal
* is found.
*/
return typed(name, {
'string, string': function stringString(s1, s2) {
return this(parse(s1), parse(s2), {});
},
'string, string, Object': function stringStringObject(s1, s2, options) {
return this(parse(s1), parse(s2), options);
},
'Node, string': function NodeString(e1, s2) {
return this(e1, parse(s2), {});
},
'Node, string, Object': function NodeStringObject(e1, s2, options) {
return this(e1, parse(s2), options);
},
'string, Node': function stringNode(s1, e2) {
return this(parse(s1), e2, {});
},
'string, Node, Object': function stringNodeObject(s1, e2, options) {
return this(parse(s1), e2, options);
},
'Node, Node': function NodeNode(e1, e2) {
return this(e1, e2, {});
},
'Node, Node, Object': function NodeNodeObject(e1, e2, options) {
var diff = new OperatorNode('-', 'subtract', [e1, e2]);
var simplified = simplify(diff, {}, options);
return isConstantNode(simplified) && !simplified.value;
}
});
});