mathjs 11.8.2 → 11.9.1

package/lib/esm/expression/embeddedDocs/function/{matrix → algebra}/schur.js

@@ -1,8 +1,8 @@
 export var schurDocs = {
   name: 'schur',
-  category: 'Matrix',
+  category: 'Algebra',
   syntax: ['schur(A)'],
   description: 'Performs a real Schur decomposition of the real matrix A = UTU\'',
-  examples: ['schur([[1, 0], [-4, 3]])', 'schur(A)'],
+  examples: ['schur([[1, 0], [-4, 3]])', 'A = [[1, 0], [-4, 3]]', 'schur(A)'],
   seealso: ['lyap', 'sylvester']
 };

package/lib/esm/expression/embeddedDocs/function/algebra/simplifyConstant.js

@@ -3,6 +3,6 @@ export var simplifyConstantDocs = {
   category: 'Algebra',
   syntax: ['simplifyConstant(expr)', 'simplifyConstant(expr, options)'],
   description: 'Replace constant subexpressions of node with their values.',
-  examples: ['simplifyConatant("(3-3)*x")', 'simplifyConstant(parse("z-cos(tau/8)"))'],
+  examples: ['simplifyConstant("(3-3)*x")', 'simplifyConstant(parse("z-cos(tau/8)"))'],
   seealso: ['simplify', 'simplifyCore', 'evaluate']
 };

package/lib/esm/expression/embeddedDocs/function/{matrix → algebra}/sylvester.js

@@ -1,8 +1,8 @@
 export var sylvesterDocs = {
   name: 'sylvester',
-  category: 'Matrix',
+  category: 'Algebra',
   syntax: ['sylvester(A,B,C)'],
   description: 'Solves the real-valued Sylvester equation AX+XB=C for X',
-  examples: ['sylvester([[-1, -2], [1, 1]], [[-2, 1], [-1, 2]], [[-3, 2], [3, 0]])', 'sylvester(A,B,C)'],
+  examples: ['sylvester([[-1, -2], [1, 1]], [[-2, 1], [-1, 2]], [[-3, 2], [3, 0]])', 'A = [[-1, -2], [1, 1]]; B = [[2, -1], [1, -2]]; C = [[-3, 2], [3, 0]]', 'sylvester(A, B, C)'],
   seealso: ['schur', 'lyap']
 };

package/lib/esm/expression/embeddedDocs/function/arithmetic/invmod.js

@@ -3,6 +3,6 @@ export var invmodDocs = {
   category: 'Arithmetic',
   syntax: ['invmod(a, b)'],
   description: 'Calculate the (modular) multiplicative inverse of a modulo b. Solution to the equation ax ≣ 1 (mod b)',
-  examples: ['invmod(8, 12)=NaN', 'invmod(7, 13)=2', 'invmod(15151, 15122)=10429'],
+  examples: ['invmod(8, 12)', 'invmod(7, 13)', 'invmod(15151, 15122)'],
   seealso: ['gcd', 'xgcd']
 };

package/lib/esm/expression/embeddedDocs/function/expression/evaluate.js

@@ -1,8 +1,8 @@
 export var evaluateDocs = {
   name: 'evaluate',
   category: 'Expression',
-  syntax: ['evaluate(expression)', 'evaluate([expr1, expr2, expr3, ...])'],
+  syntax: ['evaluate(expression)', 'evaluate(expression, scope)', 'evaluate([expr1, expr2, expr3, ...])', 'evaluate([expr1, expr2, expr3, ...], scope)'],
   description: 'Evaluate an expression or an array with expressions.',
-  examples: ['evaluate("2 + 3")', 'evaluate("sqrt(" + 4 + ")")'],
+  examples: ['evaluate("2 + 3")', 'evaluate("sqrt(16)")', 'evaluate("2 inch to cm")', 'evaluate("sin(x * pi)", { "x": 1/2 })', 'evaluate(["width=2", "height=4","width*height"])'],
   seealso: []
 };

package/lib/esm/expression/embeddedDocs/function/matrix/diff.js

@@ -3,6 +3,6 @@ export var diffDocs = {
   category: 'Matrix',
   syntax: ['diff(arr)', 'diff(arr, dim)'],
   description: ['Create a new matrix or array with the difference of the passed matrix or array.', 'Dim parameter is optional and used to indicant the dimension of the array/matrix to apply the difference', 'If no dimension parameter is passed it is assumed as dimension 0', 'Dimension is zero-based in javascript and one-based in the parser', 'Arrays must be \'rectangular\' meaning arrays like [1, 2]', 'If something is passed as a matrix it will be returned as a matrix but other than that all matrices are converted to arrays'],
-  examples: ['diff([1, 2, 4, 7, 0])', 'diff([1, 2, 4, 7, 0], 0)', 'diff(matrix([1, 2, 4, 7, 0]))', 'diff([[1, 2], [3, 4]])', 'diff([[1, 2], [3, 4]], 0)', 'diff([[1, 2], [3, 4]], 1)', 'diff([[1, 2], [3, 4]], bignumber(1))', 'diff(matrix([[1, 2], [3, 4]]), 1)', 'diff([[1, 2], matrix([3, 4])], 1)'],
+  examples: ['A = [1, 2, 4, 7, 0]', 'diff(A)', 'diff(A, 1)', 'B = [[1, 2], [3, 4]]', 'diff(B)', 'diff(B, 1)', 'diff(B, 2)', 'diff(B, bignumber(2))', 'diff([[1, 2], matrix([3, 4])], 2)'],
   seealso: ['subtract', 'partitionSelect']
 };

package/lib/esm/expression/embeddedDocs/function/matrix/range.js

@@ -3,6 +3,6 @@ export var rangeDocs = {
   category: 'Type',
   syntax: ['start:end', 'start:step:end', 'range(start, end)', 'range(start, end, step)', 'range(string)'],
   description: 'Create a range. Lower bound of the range is included, upper bound is excluded.',
-  examples: ['1:5', '3:-1:-3', 'range(3, 7)', 'range(0, 12, 2)', 'range("4:10")', 'a = [1, 2, 3, 4; 5, 6, 7, 8]', 'a[1:2, 1:2]'],
+  examples: ['1:5', '3:-1:-3', 'range(3, 7)', 'range(0, 12, 2)', 'range("4:10")', 'range(1m, 1m, 3m)', 'a = [1, 2, 3, 4; 5, 6, 7, 8]', 'a[1:2, 1:2]'],
   seealso: ['concat', 'det', 'diag', 'identity', 'inv', 'ones', 'size', 'squeeze', 'subset', 'trace', 'transpose', 'zeros']
 };

package/lib/esm/expression/embeddedDocs/function/numeric/solveODE.js

@@ -0,0 +1,8 @@
+export var solveODEDocs = {
+  name: 'solveODE',
+  category: 'Numeric',
+  syntax: ['solveODE(func, tspan, y0)', 'solveODE(func, tspan, y0, options)'],
+  description: 'Numerical Integration of Ordinary Differential Equations.',
+  examples: ['f(t,y) = y', 'tspan = [0, 4]', 'solveODE(f, tspan, 1)', 'solveODE(f, tspan, [1, 2])', 'solveODE(f, tspan, 1, { method:"RK23", maxStep:0.1 })'],
+  seealso: ['derivative', 'simplifyCore']
+};

package/lib/esm/expression/embeddedDocs/function/signal/freqz.js

@@ -0,0 +1,8 @@
+export var freqzDocs = {
+  name: 'freqz',
+  category: 'Signal',
+  syntax: ['freqz(b, a)', 'freqz(b, a, w)'],
+  description: 'Calculates the frequency response of a filter given its numerator and denominator coefficients.',
+  examples: ['freqz([1, 2], [1, 2, 3])', 'freqz([1, 2], [1, 2, 3], [0, 1])', 'freqz([1, 2], [1, 2, 3], 512)'],
+  seealso: []
+};

package/lib/esm/expression/embeddedDocs/function/signal/zpk2tf.js

@@ -0,0 +1,8 @@
+export var zpk2tfDocs = {
+  name: 'zpk2tf',
+  category: 'Signal',
+  syntax: ['zpk2tf(z, p, k)'],
+  description: 'Compute the transfer function of a zero-pole-gain model.',
+  examples: ['zpk2tf([1, 2], [-1, -2], 1)', 'zpk2tf([1, 2], [-1, -2])', 'zpk2tf([1 - 3i, 2 + 2i], [-1, -2])'],
+  seealso: []
+};

package/lib/esm/expression/embeddedDocs/function/utils/numeric.js

@@ -3,6 +3,6 @@ export var numericDocs = {
   category: 'Utils',
   syntax: ['numeric(x)'],
   description: 'Convert a numeric input to a specific numeric type: number, BigNumber, or Fraction.',
-  examples: ['numeric("4")', 'numeric("4", "number")', 'numeric("4", "BigNumber")', 'numeric("4", "Fraction)', 'numeric(4, "Fraction")', 'numeric(fraction(2, 5), "number)'],
+  examples: ['numeric("4")', 'numeric("4", "number")', 'numeric("4", "BigNumber")', 'numeric("4", "Fraction")', 'numeric(4, "Fraction")', 'numeric(fraction(2, 5), "number")'],
   seealso: ['number', 'fraction', 'bignumber', 'string', 'format']
 };

package/lib/esm/expression/node/FunctionNode.js

@@ -2,7 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { isAccessorNode, isFunctionAssignmentNode, isIndexNode, isNode, isSymbolNode } from '../../utils/is.js';
 import { escape, format } from '../../utils/string.js';
 import { hasOwnProperty } from '../../utils/object.js';
-import { getSafeProperty, validateSafeMethod } from '../../utils/customs.js';
+import { getSafeProperty, getSafeMethod } from '../../utils/customs.js';
 import { createSubScope } from '../../utils/scope.js';
 import { factory } from '../../utils/factory.js';
 import { defaultTemplate, latexFunctions } from '../../utils/latex.js';
@@ -203,7 +203,7 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
           // the function symbol is an argName
           var _rawArgs = this.args;
           return function evalFunctionNode(scope, args, context) {
-            var fn = args[_name];
+            var fn = getSafeProperty(args, _name);
             if (typeof fn !== 'function') {
               throw new TypeError("Argument '".concat(_name, "' was not a function; received: ").concat(strin(fn)));
             }
@@ -225,15 +225,14 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
         var _rawArgs2 = this.args;
         return function evalFunctionNode(scope, args, context) {
           var object = evalObject(scope, args, context);
-          validateSafeMethod(object, prop);
-          var isRaw = object[prop] && object[prop].rawArgs;
-          if (isRaw) {
+          var fn = getSafeMethod(object, prop);
+          if (fn !== null && fn !== void 0 && fn.rawArgs) {
             // "Raw" evaluation
-            return object[prop](_rawArgs2, math, createSubScope(scope, args), scope);
+            return fn(_rawArgs2, math, createSubScope(scope, args), scope);
           } else {
             // "regular" evaluation
             var values = evalArgs.map(evalArg => evalArg(scope, args, context));
-            return object[prop].apply(object, values);
+            return fn.apply(object, values);
           }
         };
       } else {

package/lib/esm/expression/node/ObjectNode.js

@@ -1,9 +1,9 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { getSafeProperty } from '../../utils/customs.js';
+import { factory } from '../../utils/factory.js';
 import { isNode } from '../../utils/is.js';
-import { escape, stringify } from '../../utils/string.js';
-import { isSafeProperty } from '../../utils/customs.js';
 import { hasOwnProperty } from '../../utils/object.js';
-import { factory } from '../../utils/factory.js';
+import { escape, stringify } from '../../utils/string.js';
 var name = 'ObjectNode';
 var dependencies = ['Node'];
 export var createObjectNode = /* #__PURE__ */factory(name, dependencies, _ref => {
@@ -58,10 +58,8 @@ export var createObjectNode = /* #__PURE__ */factory(name, dependencies, _ref =>
           // so you cannot create a key like {"co\\u006Estructor": null}
           var stringifiedKey = stringify(key);
           var parsedKey = JSON.parse(stringifiedKey);
-          if (!isSafeProperty(this.properties, parsedKey)) {
-            throw new Error('No access to property "' + parsedKey + '"');
-          }
-          evalEntries[parsedKey] = this.properties[key]._compile(math, argNames);
+          var prop = getSafeProperty(this.properties, key);
+          evalEntries[parsedKey] = prop._compile(math, argNames);
         }
       }
       return function evalObjectNode(scope, args, context) {

package/lib/esm/expression/node/SymbolNode.js

@@ -61,7 +61,7 @@ export var createSymbolNode = /* #__PURE__ */factory(name, dependencies, _ref =>
         // (like an x when inside the expression of a function
         // assignment `f(x) = ...`)
         return function (scope, args, context) {
-          return args[name];
+          return getSafeProperty(args, name);
         };
       } else if (name in math) {
         return function (scope, args, context) {

package/lib/esm/expression/transform/range.transform.js

@@ -1,7 +1,7 @@
 import { factory } from '../../utils/factory.js';
 import { createRange } from '../../function/matrix/range.js';
 var name = 'range';
-var dependencies = ['typed', 'config', '?matrix', '?bignumber', 'smaller', 'smallerEq', 'larger', 'largerEq'];
+var dependencies = ['typed', 'config', '?matrix', '?bignumber', 'smaller', 'smallerEq', 'larger', 'largerEq', 'add', 'isPositive'];
 export var createRangeTransform = /* #__PURE__ */factory(name, dependencies, _ref => {
   var {
     typed,
@@ -11,7 +11,9 @@ export var createRangeTransform = /* #__PURE__ */factory(name, dependencies, _re
     smaller,
     smallerEq,
     larger,
-    largerEq
+    largerEq,
+    add,
+    isPositive
   } = _ref;
   var range = createRange({
     typed,
@@ -21,7 +23,9 @@ export var createRangeTransform = /* #__PURE__ */factory(name, dependencies, _re
     smaller,
     smallerEq,
     larger,
-    largerEq
+    largerEq,
+    add,
+    isPositive
   });
 
   /**

package/lib/esm/factoriesAny.js

@@ -94,6 +94,7 @@ export { createCtranspose } from './function/matrix/ctranspose.js';
 export { createZeros } from './function/matrix/zeros.js';
 export { createFft } from './function/matrix/fft.js';
 export { createIfft } from './function/matrix/ifft.js';
+export { createSolveODE } from './function/numeric/solveODE.js';
 export { createErf } from './function/special/erf.js';
 export { createMode } from './function/statistics/mode.js';
 export { createProd } from './function/statistics/prod.js';
@@ -258,6 +259,8 @@ export { createResolve } from './function/algebra/resolve.js';
 export { createSymbolicEqual } from './function/algebra/symbolicEqual.js';
 export { createDerivative } from './function/algebra/derivative.js';
 export { createRationalize } from './function/algebra/rationalize.js';
+export { createZpk2tf } from './function/signal/zpk2tf.js';
+export { createFreqz } from './function/signal/freqz.js';
 export { createReviver } from './json/reviver.js';
 export { createReplacer } from './json/replacer.js';
 export { createE, createUppercaseE, createFalse, createI, createInfinity, createLN10, createLN2, createLOG10E, createLOG2E, createNaN, createNull, createPhi, createPi, createUppercasePi, createSQRT1_2,

package/lib/esm/function/algebra/simplify.js

@@ -533,6 +533,9 @@ export var createSimplify = /* #__PURE__ */factory(name, dependencies, _ref => {
   },
   // undo replace 'subtract'
   {
+    l: 'n+-(n1)',
+    r: 'n-(n1)'
+  }, {
     s: 'n*(n1^-1) -> n/n1',
     // undo replace 'divide'; for * commutative
     assuming: {

package/lib/esm/function/matrix/range.js

@@ -1,7 +1,7 @@
 import { factory } from '../../utils/factory.js';
 import { noBignumber, noMatrix } from '../../utils/noop.js';
 var name = 'range';
-var dependencies = ['typed', 'config', '?matrix', '?bignumber', 'smaller', 'smallerEq', 'larger', 'largerEq'];
+var dependencies = ['typed', 'config', '?matrix', '?bignumber', 'smaller', 'smallerEq', 'larger', 'largerEq', 'add', 'isPositive'];
 export var createRange = /* #__PURE__ */factory(name, dependencies, _ref => {
   var {
     typed,
@@ -11,7 +11,9 @@ export var createRange = /* #__PURE__ */factory(name, dependencies, _ref => {
     smaller,
     smallerEq,
     larger,
-    largerEq
+    largerEq,
+    add,
+    isPositive
   } = _ref;
   /**
    * Create an array from a range.
@@ -33,11 +35,11 @@ export var createRange = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    * - `str: string`
    *   A string 'start:end' or 'start:step:end'
-   * - `start: {number | BigNumber}`
+   * - `start: {number | BigNumber | Unit}`
    *   Start of the range
-   * - `end: number | BigNumber`
+   * - `end: number | BigNumber | Unit`
    *   End of the range, excluded by default, included when parameter includeEnd=true
-   * - `step: number | BigNumber`
+   * - `step: number | BigNumber | Unit`
    *   Step size. Default value is 1.
    * - `includeEnd: boolean`
    *   Option to specify whether to include the end or not. False by default.
@@ -48,6 +50,7 @@ export var createRange = /* #__PURE__ */factory(name, dependencies, _ref => {
    *     math.range(2, -3, -1)   // [2, 1, 0, -1, -2]
    *     math.range('2:1:6')     // [2, 3, 4, 5]
    *     math.range(2, 6, true)  // [2, 3, 4, 5, 6]
+   *     math.range(math.unit(2, 'm'), math.unit(-3, 'm'), math.unit(-1, 'm')) // [2 m, 1 m, 0 m , -1 m, -2 m]
    *
    * See also:
    *
@@ -63,30 +66,36 @@ export var createRange = /* #__PURE__ */factory(name, dependencies, _ref => {
     string: _strRange,
     'string, boolean': _strRange,
     'number, number': function numberNumber(start, end) {
-      return _out(_rangeEx(start, end, 1));
+      return _out(_range(start, end, 1, false));
     },
     'number, number, number': function numberNumberNumber(start, end, step) {
-      return _out(_rangeEx(start, end, step));
+      return _out(_range(start, end, step, false));
     },
     'number, number, boolean': function numberNumberBoolean(start, end, includeEnd) {
-      return includeEnd ? _out(_rangeInc(start, end, 1)) : _out(_rangeEx(start, end, 1));
+      return _out(_range(start, end, 1, includeEnd));
     },
     'number, number, number, boolean': function numberNumberNumberBoolean(start, end, step, includeEnd) {
-      return includeEnd ? _out(_rangeInc(start, end, step)) : _out(_rangeEx(start, end, step));
+      return _out(_range(start, end, step, includeEnd));
     },
     'BigNumber, BigNumber': function BigNumberBigNumber(start, end) {
       var BigNumber = start.constructor;
-      return _out(_bigRangeEx(start, end, new BigNumber(1)));
+      return _out(_range(start, end, new BigNumber(1), false));
     },
     'BigNumber, BigNumber, BigNumber': function BigNumberBigNumberBigNumber(start, end, step) {
-      return _out(_bigRangeEx(start, end, step));
+      return _out(_range(start, end, step, false));
     },
     'BigNumber, BigNumber, boolean': function BigNumberBigNumberBoolean(start, end, includeEnd) {
       var BigNumber = start.constructor;
-      return includeEnd ? _out(_bigRangeInc(start, end, new BigNumber(1))) : _out(_bigRangeEx(start, end, new BigNumber(1)));
+      return _out(_range(start, end, new BigNumber(1), includeEnd));
     },
     'BigNumber, BigNumber, BigNumber, boolean': function BigNumberBigNumberBigNumberBoolean(start, end, step, includeEnd) {
-      return includeEnd ? _out(_bigRangeInc(start, end, step)) : _out(_bigRangeEx(start, end, step));
+      return _out(_range(start, end, step, includeEnd));
+    },
+    'Unit, Unit, Unit': function UnitUnitUnit(start, end, step) {
+      return _out(_range(start, end, step, false));
+    },
+    'Unit, Unit, Unit, boolean': function UnitUnitUnitBoolean(start, end, step, includeEnd) {
+      return _out(_range(start, end, step, includeEnd));
     }
   });
   function _out(arr) {
@@ -100,117 +109,32 @@ export var createRange = /* #__PURE__ */factory(name, dependencies, _ref => {
     if (!r) {
       throw new SyntaxError('String "' + str + '" is no valid range');
     }
-    var fn;
     if (config.number === 'BigNumber') {
       if (bignumber === undefined) {
         noBignumber();
       }
-      fn = includeEnd ? _bigRangeInc : _bigRangeEx;
-      return _out(fn(bignumber(r.start), bignumber(r.end), bignumber(r.step)));
+      return _out(_range(bignumber(r.start), bignumber(r.end), bignumber(r.step)), includeEnd);
     } else {
-      fn = includeEnd ? _rangeInc : _rangeEx;
-      return _out(fn(r.start, r.end, r.step));
-    }
-  }
-
-  /**
-   * Create a range with numbers. End is excluded
-   * @param {number} start
-   * @param {number} end
-   * @param {number} step
-   * @returns {Array} range
-   * @private
-   */
-  function _rangeEx(start, end, step) {
-    var array = [];
-    var x = start;
-    if (step > 0) {
-      while (smaller(x, end)) {
-        array.push(x);
-        x += step;
-      }
-    } else if (step < 0) {
-      while (larger(x, end)) {
-        array.push(x);
-        x += step;
-      }
-    }
-    return array;
-  }
-
-  /**
-   * Create a range with numbers. End is included
-   * @param {number} start
-   * @param {number} end
-   * @param {number} step
-   * @returns {Array} range
-   * @private
-   */
-  function _rangeInc(start, end, step) {
-    var array = [];
-    var x = start;
-    if (step > 0) {
-      while (smallerEq(x, end)) {
-        array.push(x);
-        x += step;
-      }
-    } else if (step < 0) {
-      while (largerEq(x, end)) {
-        array.push(x);
-        x += step;
-      }
-    }
-    return array;
-  }
-
-  /**
-   * Create a range with big numbers. End is excluded
-   * @param {BigNumber} start
-   * @param {BigNumber} end
-   * @param {BigNumber} step
-   * @returns {Array} range
-   * @private
-   */
-  function _bigRangeEx(start, end, step) {
-    var zero = bignumber(0);
-    var array = [];
-    var x = start;
-    if (step.gt(zero)) {
-      while (smaller(x, end)) {
-        array.push(x);
-        x = x.plus(step);
-      }
-    } else if (step.lt(zero)) {
-      while (larger(x, end)) {
-        array.push(x);
-        x = x.plus(step);
-      }
+      return _out(_range(r.start, r.end, r.step, includeEnd));
     }
-    return array;
   }
 
   /**
-   * Create a range with big numbers. End is included
-   * @param {BigNumber} start
-   * @param {BigNumber} end
-   * @param {BigNumber} step
+   * Create a range with numbers or BigNumbers
+   * @param {number | BigNumber | Unit} start
+   * @param {number | BigNumber | Unit} end
+   * @param {number | BigNumber | Unit} step
+   * @param {boolean} includeEnd
    * @returns {Array} range
    * @private
    */
-  function _bigRangeInc(start, end, step) {
-    var zero = bignumber(0);
+  function _range(start, end, step, includeEnd) {
     var array = [];
+    var ongoing = isPositive(step) ? includeEnd ? smallerEq : smaller : includeEnd ? largerEq : larger;
     var x = start;
-    if (step.gt(zero)) {
-      while (smallerEq(x, end)) {
-        array.push(x);
-        x = x.plus(step);
-      }
-    } else if (step.lt(zero)) {
-      while (largerEq(x, end)) {
-        array.push(x);
-        x = x.plus(step);
-      }
+    while (ongoing(x, end)) {
+      array.push(x);
+      x = add(x, step);
     }
     return array;
   }