mathjs 10.6.4 → 11.1.0

package/lib/cjs/function/statistics/std.js

@@ -7,10 +7,13 @@ exports.createStd = void 0;
 
 var _factory = require("../../utils/factory.js");
 
+var _is = require("../../utils/is.js");
+
 var name = 'std';
-var dependencies = ['typed', 'sqrt', 'variance'];
+var dependencies = ['typed', 'map', 'sqrt', 'variance'];
 var createStd = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
   var typed = _ref.typed,
+      map = _ref.map,
       sqrt = _ref.sqrt,
       variance = _ref.variance;
 
@@ -87,7 +90,13 @@ var createStd = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functio
     }
 
     try {
-      return sqrt(variance.apply(null, arguments));
+      var v = variance.apply(null, arguments);
+
+      if ((0, _is.isCollection)(v)) {
+        return map(v, sqrt);
+      } else {
+        return sqrt(v);
+      }
     } catch (err) {
       if (err instanceof TypeError && err.message.indexOf(' variance') !== -1) {
         throw new TypeError(err.message.replace(' variance', ' std'));

package/lib/cjs/function/string/format.js

@@ -105,14 +105,14 @@ var createFormat = /* #__PURE__ */(0, _factory.factory)(name, dependencies, func
    * Examples:
    *
    *    math.format(6.4)                                        // returns '6.4'
-   *    math.format(1240000)                                    // returns '1.24e6'
+   *    math.format(1240000)                                    // returns '1.24e+6'
    *    math.format(1/3)                                        // returns '0.3333333333333333'
    *    math.format(1/3, 3)                                     // returns '0.333'
    *    math.format(21385, 2)                                   // returns '21000'
    *    math.format(12e8, {notation: 'fixed'})                  // returns '1200000000'
    *    math.format(2.3,  {notation: 'fixed', precision: 4})    // returns '2.3000'
    *    math.format(52.8, {notation: 'exponential'})            // returns '5.28e+1'
-   *    math.format(12400,{notation: 'engineering'})            // returns '12.400e+3'
+   *    math.format(12400, {notation: 'engineering'})           // returns '12.4e+3'
    *    math.format(2000, {lowerExp: -2, upperExp: 2})          // returns '2e+3'
    *
    *    function formatCurrency(value) {

package/lib/cjs/function/string/hex.js

@@ -18,8 +18,7 @@ var dependencies = ['typed', 'format'];
  *
  * Examples:
  *
- *    //the following outputs "0xF0"
- *    math.hex(240)
+ *    math.hex(240) // returns "0xF0"
  *
  * See also:
  *

package/lib/cjs/function/trigonometry/acos.js

@@ -7,8 +7,6 @@ exports.createAcos = void 0;
 
 var _factory = require("../../utils/factory.js");
 
-var _collection = require("../../utils/collection.js");
-
 var name = 'acos';
 var dependencies = ['typed', 'config', 'Complex'];
 var createAcos = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
@@ -19,7 +17,8 @@ var createAcos = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
   /**
    * Calculate the inverse cosine of a value.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix arccosine, this function does not
+   * apply to matrices.
    *
    * Syntax:
    *
@@ -36,8 +35,8 @@ var createAcos = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
    *
    *    cos, atan, asin
    *
-   * @param {number | BigNumber | Complex | Array | Matrix} x  Function input
-   * @return {number | BigNumber | Complex | Array | Matrix} The arc cosine of x
+   * @param {number | BigNumber | Complex} x  Function input
+   * @return {number | BigNumber | Complex} The arc cosine of x
    */
   return typed(name, {
     number: function number(x) {
@@ -52,9 +51,6 @@ var createAcos = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
     },
     BigNumber: function BigNumber(x) {
       return x.acos();
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return (0, _collection.deepMap)(x, this);
     }
   });
 });

package/lib/cjs/function/trigonometry/acosh.js

@@ -7,8 +7,6 @@ exports.createAcosh = void 0;
 
 var _factory = require("../../utils/factory.js");
 
-var _collection = require("../../utils/collection.js");
-
 var _index = require("../../plain/number/index.js");
 
 var name = 'acosh';
@@ -36,8 +34,8 @@ var createAcosh = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
    *
    *    cosh, asinh, atanh
    *
-   * @param {number | Complex | Unit | Array | Matrix} x  Function input
-   * @return {number | Complex | Array | Matrix} Hyperbolic arccosine of x
+   * @param {number | BigNumber | Complex} x  Function input
+   * @return {number | BigNumber | Complex} Hyperbolic arccosine of x
    */
   return typed(name, {
     number: function number(x) {
@@ -56,9 +54,6 @@ var createAcosh = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
     },
     BigNumber: function BigNumber(x) {
       return x.acosh();
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return (0, _collection.deepMap)(x, this);
     }
   });
 });

package/lib/cjs/function/trigonometry/acot.js

@@ -7,8 +7,6 @@ exports.createAcot = void 0;
 
 var _factory = require("../../utils/factory.js");
 
-var _collection = require("../../utils/collection.js");
-
 var _index = require("../../plain/number/index.js");
 
 var name = 'acot';
@@ -20,7 +18,8 @@ var createAcot = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
   /**
    * Calculate the inverse cotangent of a value, defined as `acot(x) = atan(1/x)`.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix arccotanget, this function does not
+   * apply to matrices.
    *
    * Syntax:
    *
@@ -28,17 +27,16 @@ var createAcot = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
    *
    * Examples:
    *
-   *    math.acot(0.5)           // returns number 0.4636476090008061
+   *    math.acot(0.5)           // returns number 1.1071487177940904
+   *    math.acot(2)             // returns number 0.4636476090008061
    *    math.acot(math.cot(1.5)) // returns number 1.5
    *
-   *    math.acot(2)             // returns Complex 1.5707963267948966 -1.3169578969248166 i
-   *
    * See also:
    *
    *    cot, atan
    *
-   * @param {number | Complex | Array | Matrix} x   Function input
-   * @return {number | Complex | Array | Matrix} The arc cotangent of x
+   * @param {number | BigNumber| Complex} x   Function input
+   * @return {number | BigNumber| Complex} The arc cotangent of x
    */
   return typed(name, {
     number: _index.acotNumber,
@@ -47,9 +45,6 @@ var createAcot = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
     },
     BigNumber: function BigNumber(x) {
       return new _BigNumber(1).div(x).atan();
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return (0, _collection.deepMap)(x, this);
     }
   });
 });

package/lib/cjs/function/trigonometry/acoth.js

@@ -7,8 +7,6 @@ exports.createAcoth = void 0;
 
 var _factory = require("../../utils/factory.js");
 
-var _collection = require("../../utils/collection.js");
-
 var _index = require("../../plain/number/index.js");
 
 var name = 'acoth';
@@ -23,7 +21,8 @@ var createAcoth = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
    * Calculate the hyperbolic arccotangent of a value,
    * defined as `acoth(x) = atanh(1/x) = (ln((x+1)/x) + ln(x/(x-1))) / 2`.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix hyperbolic arccotangent, this
+   * function does not apply to matrices.
    *
    * Syntax:
    *
@@ -37,8 +36,8 @@ var createAcoth = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
    *
    *    acsch, asech
    *
-   * @param {number | Complex | Array | Matrix} x  Function input
-   * @return {number | Complex | Array | Matrix} Hyperbolic arccotangent of x
+   * @param {number | BigNumber | Complex} x  Function input
+   * @return {number | BigNumber | Complex} Hyperbolic arccotangent of x
    */
   return typed(name, {
     number: function number(x) {
@@ -53,9 +52,6 @@ var createAcoth = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
     },
     BigNumber: function BigNumber(x) {
       return new _BigNumber(1).div(x).atanh();
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return (0, _collection.deepMap)(x, this);
     }
   });
 });

package/lib/cjs/function/trigonometry/acsc.js

@@ -7,8 +7,6 @@ exports.createAcsc = void 0;
 
 var _factory = require("../../utils/factory.js");
 
-var _collection = require("../../utils/collection.js");
-
 var _index = require("../../plain/number/index.js");
 
 var name = 'acsc';
@@ -22,7 +20,8 @@ var createAcsc = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
   /**
    * Calculate the inverse cosecant of a value, defined as `acsc(x) = asin(1/x)`.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix arccosecant, this function does not
+   * apply to matrices.
    *
    * Syntax:
    *
@@ -30,17 +29,16 @@ var createAcsc = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
    *
    * Examples:
    *
-   *    math.acsc(0.5)           // returns number 0.5235987755982989
+   *    math.acsc(2)             // returns 0.5235987755982989
+   *    math.acsc(0.5)           // returns Complex 1.5707963267948966 -1.3169578969248166i
    *    math.acsc(math.csc(1.5)) // returns number ~1.5
    *
-   *    math.acsc(2)             // returns Complex 1.5707963267948966 -1.3169578969248166 i
-   *
    * See also:
    *
    *    csc, asin, asec
    *
-   * @param {number | Complex | Array | Matrix} x   Function input
-   * @return {number | Complex | Array | Matrix} The arc cosecant of x
+   * @param {number | BigNumber | Complex} x   Function input
+   * @return {number | BigNumber | Complex} The arc cosecant of x
    */
   return typed(name, {
     number: function number(x) {
@@ -55,9 +53,6 @@ var createAcsc = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
     },
     BigNumber: function BigNumber(x) {
       return new _BigNumber(1).div(x).asin();
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return (0, _collection.deepMap)(x, this);
     }
   });
 });

package/lib/cjs/function/trigonometry/acsch.js

@@ -7,8 +7,6 @@ exports.createAcsch = void 0;
 
 var _factory = require("../../utils/factory.js");
 
-var _collection = require("../../utils/collection.js");
-
 var _index = require("../../plain/number/index.js");
 
 var name = 'acsch';
@@ -21,7 +19,8 @@ var createAcsch = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
    * Calculate the hyperbolic arccosecant of a value,
    * defined as `acsch(x) = asinh(1/x) = ln(1/x + sqrt(1/x^2 + 1))`.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix hyperbolic arccosecant, this function
+   * does not apply to matrices.
    *
    * Syntax:
    *
@@ -35,8 +34,8 @@ var createAcsch = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
    *
    *    asech, acoth
    *
-   * @param {number | Complex | Array | Matrix} x  Function input
-   * @return {number | Complex | Array | Matrix} Hyperbolic arccosecant of x
+   * @param {number | BigNumber | Complex} x  Function input
+   * @return {number | BigNumber | Complex} Hyperbolic arccosecant of x
    */
   return typed(name, {
     number: _index.acschNumber,
@@ -45,9 +44,6 @@ var createAcsch = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
     },
     BigNumber: function BigNumber(x) {
       return new _BigNumber(1).div(x).asinh();
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return (0, _collection.deepMap)(x, this);
     }
   });
 });

package/lib/cjs/function/trigonometry/asec.js

@@ -7,8 +7,6 @@ exports.createAsec = void 0;
 
 var _factory = require("../../utils/factory.js");
 
-var _collection = require("../../utils/collection.js");
-
 var _index = require("../../plain/number/index.js");
 
 var name = 'asec';
@@ -22,7 +20,8 @@ var createAsec = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
   /**
    * Calculate the inverse secant of a value. Defined as `asec(x) = acos(1/x)`.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix arcsecant, this function does not
+   * apply to matrices.
    *
    * Syntax:
    *
@@ -30,17 +29,17 @@ var createAsec = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
    *
    * Examples:
    *
-   *    math.asec(0.5)           // returns 1.0471975511965979
+   *    math.asec(2)             // returns 1.0471975511965979
    *    math.asec(math.sec(1.5)) // returns 1.5
    *
-   *    math.asec(2)             // returns 0 + 1.3169578969248166 i
+   *    math.asec(0.5)           // returns Complex 0 + 1.3169578969248166i
    *
    * See also:
    *
    *    acos, acot, acsc
    *
-   * @param {number | Complex | Array | Matrix} x  Function input
-   * @return {number | Complex | Array | Matrix} The arc secant of x
+   * @param {number | BigNumber | Complex} x  Function input
+   * @return {number | BigNumber | Complex} The arc secant of x
    */
   return typed(name, {
     number: function number(x) {
@@ -55,9 +54,6 @@ var createAsec = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
     },
     BigNumber: function BigNumber(x) {
       return new _BigNumber(1).div(x).acos();
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return (0, _collection.deepMap)(x, this);
     }
   });
 });

package/lib/cjs/function/trigonometry/asech.js

@@ -7,8 +7,6 @@ exports.createAsech = void 0;
 
 var _factory = require("../../utils/factory.js");
 
-var _collection = require("../../utils/collection.js");
-
 var _index = require("../../plain/number/index.js");
 
 var name = 'asech';
@@ -23,7 +21,8 @@ var createAsech = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
    * Calculate the hyperbolic arcsecant of a value,
    * defined as `asech(x) = acosh(1/x) = ln(sqrt(1/x^2 - 1) + 1/x)`.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix hyperbolic arcsecant, this function
+   * does not apply to matrices.
    *
    * Syntax:
    *
@@ -37,8 +36,8 @@ var createAsech = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
    *
    *    acsch, acoth
    *
-   * @param {number | Complex | Array | Matrix} x  Function input
-   * @return {number | Complex | Array | Matrix} Hyperbolic arcsecant of x
+   * @param {number | BigNumber | Complex} x  Function input
+   * @return {number | BigNumber | Complex} Hyperbolic arcsecant of x
    */
   return typed(name, {
     number: function number(x) {
@@ -60,9 +59,6 @@ var createAsech = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
     },
     BigNumber: function BigNumber(x) {
       return new _BigNumber(1).div(x).acosh();
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      return (0, _collection.deepMap)(x, this);
     }
   });
 });

package/lib/cjs/function/trigonometry/asin.js

@@ -7,8 +7,6 @@ exports.createAsin = void 0;
 
 var _factory = require("../../utils/factory.js");
 
-var _collection = require("../../utils/collection.js");
-
 var name = 'asin';
 var dependencies = ['typed', 'config', 'Complex'];
 var createAsin = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
@@ -19,7 +17,8 @@ var createAsin = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
   /**
    * Calculate the inverse sine of a value.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matric arcsine, this function does not apply
+   * to matrices.
    *
    * Syntax:
    *
@@ -30,14 +29,14 @@ var createAsin = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
    *    math.asin(0.5)           // returns number 0.5235987755982989
    *    math.asin(math.sin(1.5)) // returns number ~1.5
    *
-   *    math.asin(2)             // returns Complex 1.5707963267948966 -1.3169578969248166 i
+   *    math.asin(2)             // returns Complex 1.5707963267948966 -1.3169578969248166i
    *
    * See also:
    *
    *    sin, atan, acos
    *
-   * @param {number | BigNumber | Complex | Array | Matrix} x   Function input
-   * @return {number | BigNumber | Complex | Array | Matrix} The arc sine of x
+   * @param {number | BigNumber | Complex} x   Function input
+   * @return {number | BigNumber | Complex} The arc sine of x
    */
   return typed(name, {
     number: function number(x) {
@@ -52,10 +51,6 @@ var createAsin = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
     },
     BigNumber: function BigNumber(x) {
       return x.asin();
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      // deep map collection, skip zeros since asin(0) = 0
-      return (0, _collection.deepMap)(x, this, true);
     }
   });
 });

package/lib/cjs/function/trigonometry/asinh.js

@@ -7,8 +7,6 @@ exports.createAsinh = void 0;
 
 var _factory = require("../../utils/factory.js");
 
-var _collection = require("../../utils/collection.js");
-
 var _index = require("../../plain/number/index.js");
 
 var name = 'asinh';
@@ -20,7 +18,8 @@ var createAsinh = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
    * Calculate the hyperbolic arcsine of a value,
    * defined as `asinh(x) = ln(x + sqrt(x^2 + 1))`.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with the matrix hyperbolic arcsine, this function
+   * does not apply to matrices.
    *
    * Syntax:
    *
@@ -34,8 +33,8 @@ var createAsinh = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
    *
    *    acosh, atanh
    *
-   * @param {number | Complex | Array | Matrix} x  Function input
-   * @return {number | Complex | Array | Matrix} Hyperbolic arcsine of x
+   * @param {number | BigNumber | Complex} x  Function input
+   * @return {number | BigNumber | Complex} Hyperbolic arcsine of x
    */
   return typed('asinh', {
     number: _index.asinhNumber,
@@ -44,10 +43,6 @@ var createAsinh = /* #__PURE__ */(0, _factory.factory)(name, dependencies, funct
     },
     BigNumber: function BigNumber(x) {
       return x.asinh();
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      // deep map collection, skip zeros since asinh(0) = 0
-      return (0, _collection.deepMap)(x, this, true);
     }
   });
 });

package/lib/cjs/function/trigonometry/atan.js

@@ -7,8 +7,6 @@ exports.createAtan = void 0;
 
 var _factory = require("../../utils/factory.js");
 
-var _collection = require("../../utils/collection.js");
-
 var name = 'atan';
 var dependencies = ['typed'];
 var createAtan = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
@@ -17,7 +15,8 @@ var createAtan = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
   /**
    * Calculate the inverse tangent of a value.
    *
-   * For matrices, the function is evaluated element wise.
+   * To avoid confusion with matrix arctangent, this function does not apply
+   * to matrices.
    *
    * Syntax:
    *
@@ -26,16 +25,15 @@ var createAtan = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
    * Examples:
    *
    *    math.atan(0.5)           // returns number 0.4636476090008061
+   *    math.atan(2)             // returns number 1.1071487177940904
    *    math.atan(math.tan(1.5)) // returns number 1.5
    *
-   *    math.atan(2)             // returns Complex 1.5707963267948966 -1.3169578969248166 i
-   *
    * See also:
    *
    *    tan, asin, acos
    *
-   * @param {number | BigNumber | Complex | Array | Matrix} x   Function input
-   * @return {number | BigNumber | Complex | Array | Matrix} The arc tangent of x
+   * @param {number | BigNumber | Complex} x   Function input
+   * @return {number | BigNumber | Complex} The arc tangent of x
    */
   return typed('atan', {
     number: function number(x) {
@@ -46,10 +44,6 @@ var createAtan = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
     },
     BigNumber: function BigNumber(x) {
       return x.atan();
-    },
-    'Array | Matrix': function ArrayMatrix(x) {
-      // deep map collection, skip zeros since atan(0) = 0
-      return (0, _collection.deepMap)(x, this, true);
     }
   });
 });