mathjs 10.6.4 → 11.1.0

package/lib/esm/function/trigonometry/sech.js

@@ -1,5 +1,4 @@
 import { factory } from '../../utils/factory.js';
-import { deepMap } from '../../utils/collection.js';
 import { sechNumber } from '../../plain/number/index.js';
 var name = 'sech';
 var dependencies = ['typed', 'BigNumber'];
@@ -13,7 +12,8 @@ export var createSech = /* #__PURE__ */factory(name, dependencies, _ref => {
    * Calculate the hyperbolic secant of a value,
    * defined as `sech(x) = 1 / cosh(x)`.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix hyperbolic secant, this function does
+   * not apply to matrices.
    *
    * Syntax:
    *
@@ -29,26 +29,12 @@ export var createSech = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    *    cosh, csch, coth
    *
-   * @param {number | Complex | Unit | Array | Matrix} x  Function input
-   * @return {number | Complex | Array | Matrix} Hyperbolic secant of x
+   * @param {number | BigNumber | Complex} x  Function input
+   * @return {number | BigNumber | Complex} Hyperbolic secant of x
    */
   return typed(name, {
     number: sechNumber,
-    Complex: function Complex(x) {
-      return x.sech();
-    },
-    BigNumber: function BigNumber(x) {
-      return new _BigNumber(1).div(x.cosh());
-    },
-    Unit: function Unit(x) {
-      if (!x.hasBase(x.constructor.BASE_UNITS.ANGLE)) {
-        throw new TypeError('Unit in function sech is no angle');
-      }
-
-      return this(x.value);
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return deepMap(x, this);
-    }
+    Complex: x => x.sech(),
+    BigNumber: x => new _BigNumber(1).div(x.cosh())
   });
 });

package/lib/esm/function/trigonometry/sin.js

@@ -1,16 +1,19 @@
 import { factory } from '../../utils/factory.js';
-import { deepMap } from '../../utils/collection.js';
+import { createTrigUnit } from './trigUnit.js';
 var name = 'sin';
 var dependencies = ['typed'];
 export var createSin = /* #__PURE__ */factory(name, dependencies, _ref => {
   var {
     typed
   } = _ref;
-
+  var trigUnit = createTrigUnit({
+    typed
+  });
   /**
    * Calculate the sine of a value.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix sine, this function does not apply
+   * to matrices.
    *
    * Syntax:
    *
@@ -30,27 +33,12 @@ export var createSin = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    *    cos, tan
    *
-   * @param {number | BigNumber | Complex | Unit | Array | Matrix} x  Function input
-   * @return {number | BigNumber | Complex | Array | Matrix} Sine of x
+   * @param {number | BigNumber | Complex | Unit} x  Function input
+   * @return {number | BigNumber | Complex} Sine of x
    */
+
   return typed(name, {
     number: Math.sin,
-    Complex: function Complex(x) {
-      return x.sin();
-    },
-    BigNumber: function BigNumber(x) {
-      return x.sin();
-    },
-    Unit: function Unit(x) {
-      if (!x.hasBase(x.constructor.BASE_UNITS.ANGLE)) {
-        throw new TypeError('Unit in function sin is no angle');
-      }
-
-      return this(x.value);
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      // deep map collection, skip zeros since sin(0) = 0
-      return deepMap(x, this, true);
-    }
-  });
+    'Complex | BigNumber': x => x.sin()
+  }, trigUnit);
 });

package/lib/esm/function/trigonometry/sinh.js

@@ -1,5 +1,4 @@
 import { factory } from '../../utils/factory.js';
-import { deepMap } from '../../utils/collection.js';
 import { sinhNumber } from '../../plain/number/index.js';
 var name = 'sinh';
 var dependencies = ['typed'];
@@ -12,7 +11,8 @@ export var createSinh = /* #__PURE__ */factory(name, dependencies, _ref => {
    * Calculate the hyperbolic sine of a value,
    * defined as `sinh(x) = 1/2 * (exp(x) - exp(-x))`.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix hyperbolic sine, this function does
+   * not apply to matrices.
    *
    * Syntax:
    *
@@ -26,27 +26,11 @@ export var createSinh = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    *    cosh, tanh
    *
-   * @param {number | BigNumber | Complex | Unit | Array | Matrix} x  Function input
-   * @return {number | BigNumber | Complex | Array | Matrix} Hyperbolic sine of x
+   * @param {number | BigNumber | Complex} x  Function input
+   * @return {number | BigNumber | Complex} Hyperbolic sine of x
    */
   return typed(name, {
     number: sinhNumber,
-    Complex: function Complex(x) {
-      return x.sinh();
-    },
-    BigNumber: function BigNumber(x) {
-      return x.sinh();
-    },
-    Unit: function Unit(x) {
-      if (!x.hasBase(x.constructor.BASE_UNITS.ANGLE)) {
-        throw new TypeError('Unit in function sinh is no angle');
-      }
-
-      return this(x.value);
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      // deep map collection, skip zeros since sinh(0) = 0
-      return deepMap(x, this, true);
-    }
+    'Complex | BigNumber': x => x.sinh()
   });
 });

package/lib/esm/function/trigonometry/tan.js

@@ -1,16 +1,19 @@
 import { factory } from '../../utils/factory.js';
-import { deepMap } from '../../utils/collection.js';
+import { createTrigUnit } from './trigUnit.js';
 var name = 'tan';
 var dependencies = ['typed'];
 export var createTan = /* #__PURE__ */factory(name, dependencies, _ref => {
   var {
     typed
   } = _ref;
-
+  var trigUnit = createTrigUnit({
+    typed
+  });
   /**
    * Calculate the tangent of a value. `tan(x)` is equal to `sin(x) / cos(x)`.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix tangent, this function does not apply
+   * to matrices.
    *
    * Syntax:
    *
@@ -27,27 +30,12 @@ export var createTan = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    *    atan, sin, cos
    *
-   * @param {number | BigNumber | Complex | Unit | Array | Matrix} x  Function input
-   * @return {number | BigNumber | Complex | Array | Matrix} Tangent of x
+   * @param {number | BigNumber | Complex | Unit} x  Function input
+   * @return {number | BigNumber | Complex} Tangent of x
    */
+
   return typed(name, {
     number: Math.tan,
-    Complex: function Complex(x) {
-      return x.tan();
-    },
-    BigNumber: function BigNumber(x) {
-      return x.tan();
-    },
-    Unit: function Unit(x) {
-      if (!x.hasBase(x.constructor.BASE_UNITS.ANGLE)) {
-        throw new TypeError('Unit in function tan is no angle');
-      }
-
-      return this(x.value);
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      // deep map collection, skip zeros since tan(0) = 0
-      return deepMap(x, this, true);
-    }
-  });
+    'Complex | BigNumber': x => x.tan()
+  }, trigUnit);
 });

package/lib/esm/function/trigonometry/tanh.js

@@ -1,5 +1,4 @@
 import { factory } from '../../utils/factory.js';
-import { deepMap } from '../../utils/collection.js';
 import { tanh as _tanh } from '../../utils/number.js';
 var name = 'tanh';
 var dependencies = ['typed'];
@@ -12,7 +11,8 @@ export var createTanh = /* #__PURE__ */factory(name, dependencies, _ref => {
    * Calculate the hyperbolic tangent of a value,
    * defined as `tanh(x) = (exp(2 * x) - 1) / (exp(2 * x) + 1)`.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with matrix hyperbolic tangent, this function does
+   * not apply to matrices.
    *
    * Syntax:
    *
@@ -29,27 +29,11 @@ export var createTanh = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    *    sinh, cosh, coth
    *
-   * @param {number | BigNumber | Complex | Unit | Array | Matrix} x  Function input
-   * @return {number | BigNumber | Complex | Array | Matrix} Hyperbolic tangent of x
+   * @param {number | BigNumber | Complex} x  Function input
+   * @return {number | BigNumber | Complex} Hyperbolic tangent of x
    */
   return typed('tanh', {
     number: _tanh,
-    Complex: function Complex(x) {
-      return x.tanh();
-    },
-    BigNumber: function BigNumber(x) {
-      return x.tanh();
-    },
-    Unit: function Unit(x) {
-      if (!x.hasBase(x.constructor.BASE_UNITS.ANGLE)) {
-        throw new TypeError('Unit in function tanh is no angle');
-      }
-
-      return this(x.value);
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      // deep map collection, skip zeros since tanh(0) = 0
-      return deepMap(x, this, true);
-    }
+    'Complex | BigNumber': x => x.tanh()
   });
 });

package/lib/esm/function/trigonometry/trigUnit.js

@@ -0,0 +1,15 @@
+import { factory } from '../../utils/factory.js';
+export var createTrigUnit = /* #__PURE__ */factory('trigUnit', ['typed'], _ref => {
+  var {
+    typed
+  } = _ref;
+  return {
+    Unit: typed.referToSelf(self => x => {
+      if (!x.hasBase(x.constructor.BASE_UNITS.ANGLE)) {
+        throw new TypeError('Unit in function cot is no angle');
+      }
+
+      return typed.find(self, x.valueType())(x.value);
+    })
+  };
+});

package/lib/esm/function/unit/to.js

@@ -1,6 +1,5 @@
 import { factory } from '../../utils/factory.js';
-import { createAlgorithm13 } from '../../type/matrix/utils/algorithm13.js';
-import { createAlgorithm14 } from '../../type/matrix/utils/algorithm14.js';
+import { createMatrixAlgorithmSuite } from '../../type/matrix/utils/matrixAlgorithmSuite.js';
 var name = 'to';
 var dependencies = ['typed', 'matrix'];
 export var createTo = /* #__PURE__ */factory(name, dependencies, _ref => {
@@ -8,11 +7,9 @@ export var createTo = /* #__PURE__ */factory(name, dependencies, _ref => {
     typed,
     matrix
   } = _ref;
-  var algorithm13 = createAlgorithm13({
-    typed
-  });
-  var algorithm14 = createAlgorithm14({
-    typed
+  var matrixAlgorithmSuite = createMatrixAlgorithmSuite({
+    typed,
+    matrix
   });
   /**
    * Change the unit of a value.
@@ -40,40 +37,8 @@ export var createTo = /* #__PURE__ */factory(name, dependencies, _ref => {
    */
 
   return typed(name, {
-    'Unit, Unit | string': function UnitUnitString(x, unit) {
-      return x.to(unit);
-    },
-    'Matrix, Matrix': function MatrixMatrix(x, y) {
-      // SparseMatrix does not support Units
-      return algorithm13(x, y, this);
-    },
-    'Array, Array': function ArrayArray(x, y) {
-      // use matrix implementation
-      return this(matrix(x), matrix(y)).valueOf();
-    },
-    'Array, Matrix': function ArrayMatrix(x, y) {
-      // use matrix implementation
-      return this(matrix(x), y);
-    },
-    'Matrix, Array': function MatrixArray(x, y) {
-      // use matrix implementation
-      return this(x, matrix(y));
-    },
-    'Matrix, any': function MatrixAny(x, y) {
-      // SparseMatrix does not support Units
-      return algorithm14(x, y, this, false);
-    },
-    'any, Matrix': function anyMatrix(x, y) {
-      // SparseMatrix does not support Units
-      return algorithm14(y, x, this, true);
-    },
-    'Array, any': function ArrayAny(x, y) {
-      // use matrix implementation
-      return algorithm14(matrix(x), y, this, false).valueOf();
-    },
-    'any, Array': function anyArray(x, y) {
-      // use matrix implementation
-      return algorithm14(matrix(y), x, this, true).valueOf();
-    }
-  });
+    'Unit, Unit | string': (x, unit) => x.to(unit)
+  }, matrixAlgorithmSuite({
+    Ds: true
+  }));
 });

package/lib/esm/function/utils/clone.js

@@ -17,7 +17,7 @@ export var createClone = /* #__PURE__ */factory(name, dependencies, _ref => {
    * Examples:
    *
    *    math.clone(3.5)                   // returns number 3.5
-   *    math.clone(math.complex('2-4i') // returns Complex 2 - 4i
+   *    math.clone(math.complex('2-4i'))  // returns Complex 2 - 4i
    *    math.clone(math.unit(45, 'deg'))  // returns Unit 45 deg
    *    math.clone([[1, 2], [3, 4]])      // returns Array [[1, 2], [3, 4]]
    *    math.clone("hello world")         // returns string "hello world"

package/lib/esm/function/utils/hasNumericValue.js

@@ -24,7 +24,8 @@ export var createHasNumericValue = /* #__PURE__ */factory(name, dependencies, _r
    *    math.hasNumericValue(0)                     // returns true
    *    math.hasNumericValue(math.bignumber(500))   // returns true
    *    math.hasNumericValue(math.fraction(4))      // returns true
-   *    math.hasNumericValue(math.complex('2-4i')   // returns false
+   *    math.hasNumericValue(math.complex('2-4i'))  // returns false
+   *    math.hasNumericValue(false)                 // returns true
    *    math.hasNumericValue([2.3, 'foo', false])   // returns [true, false, true]
    *
    * See also:
@@ -37,6 +38,7 @@ export var createHasNumericValue = /* #__PURE__ */factory(name, dependencies, _r
    *                    Throws an error in case of unknown types.
    */
   return typed(name, {
+    boolean: () => true,
     string: function string(x) {
       return x.trim().length > 0 && !isNaN(Number(x));
     },

package/lib/esm/function/utils/isInteger.js

@@ -27,7 +27,7 @@ export var createIsInteger = /* #__PURE__ */factory(name, dependencies, _ref =>
    *    math.isInteger(math.fraction(4))      // returns true
    *    math.isInteger('3')                   // returns true
    *    math.isInteger([3, 0.5, -2])          // returns [true, false, true]
-   *    math.isInteger(math.complex('2-4i')   // throws an error
+   *    math.isInteger(math.complex('2-4i'))  // throws an error
    *
    * See also:
    *
@@ -46,8 +46,6 @@ export var createIsInteger = /* #__PURE__ */factory(name, dependencies, _ref =>
     Fraction: function Fraction(x) {
       return x.d === 1 && isFinite(x.n);
     },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return deepMap(x, this);
-    }
+    'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
   });
 });

package/lib/esm/function/utils/isNaN.js

@@ -27,7 +27,7 @@ export var createIsNaN = /* #__PURE__ */factory(name, dependencies, _ref => {
    *    math.isNaN(math.bignumber(0))     // returns false
    *    math.isNaN(math.fraction(-2, 5))  // returns false
    *    math.isNaN('-2')                  // returns false
-   *    math.isNaN([2, 0, -3, NaN]')      // returns [false, false, false, true]
+   *    math.isNaN([2, 0, -3, NaN])       // returns [false, false, false, true]
    *
    * See also:
    *

package/lib/esm/function/utils/isNegative.js

@@ -27,7 +27,7 @@ export var createIsNegative = /* #__PURE__ */factory(name, dependencies, _ref =>
    *    math.isNegative(math.bignumber(2))     // returns false
    *    math.isNegative(math.fraction(-2, 5))  // returns true
    *    math.isNegative('-2')                  // returns true
-   *    math.isNegative([2, 0, -3]')           // returns [false, false, true]
+   *    math.isNegative([2, 0, -3])            // returns [false, false, true]
    *
    * See also:
    *
@@ -45,11 +45,7 @@ export var createIsNegative = /* #__PURE__ */factory(name, dependencies, _ref =>
     Fraction: function Fraction(x) {
       return x.s < 0; // It's enough to decide on the sign
     },
-    Unit: function Unit(x) {
-      return this(x.value);
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return deepMap(x, this);
-    }
+    Unit: typed.referToSelf(self => x => typed.find(self, x.valueType())(x.value)),
+    'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
   });
 });

package/lib/esm/function/utils/isNumeric.js

@@ -24,7 +24,7 @@ export var createIsNumeric = /* #__PURE__ */factory(name, dependencies, _ref =>
    *    math.isNumeric(0)                     // returns true
    *    math.isNumeric(math.bignumber(500))   // returns true
    *    math.isNumeric(math.fraction(4))      // returns true
-   *    math.isNumeric(math.complex('2-4i')   // returns false
+   *    math.isNumeric(math.complex('2-4i'))  // returns false
    *    math.isNumeric([2.3, 'foo', false])   // returns [true, false, true]
    *
    * See also:
@@ -37,14 +37,8 @@ export var createIsNumeric = /* #__PURE__ */factory(name, dependencies, _ref =>
    *                    Throws an error in case of unknown types.
    */
   return typed(name, {
-    'number | BigNumber | Fraction | boolean': function numberBigNumberFractionBoolean() {
-      return true;
-    },
-    'Complex | Unit | string | null | undefined | Node': function ComplexUnitStringNullUndefinedNode() {
-      return false;
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return deepMap(x, this);
-    }
+    'number | BigNumber | Fraction | boolean': () => true,
+    'Complex | Unit | string | null | undefined | Node': () => false,
+    'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
   });
 });

package/lib/esm/function/utils/isPositive.js

@@ -27,7 +27,7 @@ export var createIsPositive = /* #__PURE__ */factory(name, dependencies, _ref =>
    *    math.isPositive(0.5)                   // returns true
    *    math.isPositive(math.bignumber(2))     // returns true
    *    math.isPositive(math.fraction(-2, 5))  // returns false
-   *    math.isPositive(math.fraction(1,3))    // returns false
+   *    math.isPositive(math.fraction(1, 3))   // returns true
    *    math.isPositive('2')                   // returns true
    *    math.isPositive([2, 0, -3])            // returns [true, false, false]
    *
@@ -47,11 +47,7 @@ export var createIsPositive = /* #__PURE__ */factory(name, dependencies, _ref =>
     Fraction: function Fraction(x) {
       return x.s > 0 && x.n > 0;
     },
-    Unit: function Unit(x) {
-      return this(x.value);
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return deepMap(x, this);
-    }
+    Unit: typed.referToSelf(self => x => typed.find(self, x.valueType())(x.value)),
+    'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
   });
 });

package/lib/esm/function/utils/isPrime.js

@@ -135,8 +135,6 @@ export var createIsPrime = /* #__PURE__ */factory(name, dependencies, _ref => {
 
       return true;
     },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return deepMap(x, this);
-    }
+    'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
   });
 });

package/lib/esm/function/utils/isZero.js

@@ -21,17 +21,17 @@ export var createIsZero = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    * Examples:
    *
-   *    math.isZero(0)                     // returns true
-   *    math.isZero(2)                     // returns false
-   *    math.isZero(0.5)                   // returns false
-   *    math.isZero(math.bignumber(0))     // returns true
-   *    math.isZero(math.fraction(0))      // returns true
-   *    math.isZero(math.fraction(1,3))    // returns false
-   *    math.isZero(math.complex('2 - 4i') // returns false
-   *    math.isZero(math.complex('0i')     // returns true
-   *    math.isZero('0')                   // returns true
-   *    math.isZero('2')                   // returns false
-   *    math.isZero([2, 0, -3]')           // returns [false, true, false]
+   *    math.isZero(0)                      // returns true
+   *    math.isZero(2)                      // returns false
+   *    math.isZero(0.5)                    // returns false
+   *    math.isZero(math.bignumber(0))      // returns true
+   *    math.isZero(math.fraction(0))       // returns true
+   *    math.isZero(math.fraction(1,3))     // returns false
+   *    math.isZero(math.complex('2 - 4i')) // returns false
+   *    math.isZero(math.complex('0i'))     // returns true
+   *    math.isZero('0')                    // returns true
+   *    math.isZero('2')                    // returns false
+   *    math.isZero([2, 0, -3])             // returns [false, true, false]
    *
    * See also:
    *
@@ -52,11 +52,7 @@ export var createIsZero = /* #__PURE__ */factory(name, dependencies, _ref => {
     Fraction: function Fraction(x) {
       return x.d === 1 && x.n === 0;
     },
-    Unit: function Unit(x) {
-      return this(x.value);
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return deepMap(x, this);
-    }
+    Unit: typed.referToSelf(self => x => typed.find(self, x.valueType())(x.value)),
+    'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
   });
 });

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

@@ -30,12 +30,12 @@ export var createNumeric = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    * Examples:
    *
-   *    math.numeric('4')                           // returns number 4
-   *    math.numeric('4', 'number')                 // returns number 4
+   *    math.numeric('4')                           // returns 4
+   *    math.numeric('4', 'number')                 // returns 4
    *    math.numeric('4', 'BigNumber')              // returns BigNumber 4
    *    math.numeric('4', 'Fraction')               // returns Fraction 4
    *    math.numeric(4, 'Fraction')                 // returns Fraction 4
-   *    math.numeric(math.fraction(2, 5), 'number') // returns number 0.4
+   *    math.numeric(math.fraction(2, 5), 'number') // returns 0.4
    *
    * See also:
    *
@@ -50,7 +50,14 @@ export var createNumeric = /* #__PURE__ */factory(name, dependencies, _ref => {
    *              Returns an instance of the numeric in the requested type
    */
 
-  return function numeric(value, outputType) {
+  return function numeric(value) {
+    var outputType = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'number';
+    var check = arguments.length > 2 ? arguments[2] : undefined;
+
+    if (check !== undefined) {
+      throw new SyntaxError('numeric() takes one or two arguments');
+    }
+
     var inputType = typeOf(value);
 
     if (!(inputType in validInputTypes)) {