mathjs 9.3.2 → 9.4.0

package/lib/cjs/function/matrix/matrixFromColumns.js

@@ -0,0 +1,118 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createMatrixFromColumns = void 0;
+
+var _factory = require("../../utils/factory.js");
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+var name = 'matrixFromColumns';
+var dependencies = ['typed', 'matrix', 'flatten', 'size'];
+var createMatrixFromColumns = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
+  var typed = _ref.typed,
+      matrix = _ref.matrix,
+      flatten = _ref.flatten,
+      size = _ref.size;
+
+  /**
+   * Create a dense matrix from vectors as individual columns.
+   * If you pass row vectors, they will be transposed (but not conjugated!)
+   *
+   * Syntax:
+   *
+   *    math.matrixFromColumns(...arr)
+   *    math.matrixFromColumns(col1, col2)
+   *    math.matrixFromColumns(col1, col2, col3)
+   *
+   * Examples:
+   *
+   *    math.matrixFromColumns([1, 2, 3], [[4],[5],[6]])
+   *    math.matrixFromColumns(...vectors)
+   *
+   * See also:
+   *
+   *    matrix, matrixFromRows, matrixFromFunction, zeros
+   *
+   * @param {... Array | Matrix} cols Multiple columns
+   * @return { number[][] | Matrix } if at least one of the arguments is an array, an array will be returned
+   */
+  return typed(name, {
+    '...Array': function Array(arr) {
+      return _createArray(arr);
+    },
+    '...Matrix': function Matrix(arr) {
+      return matrix(_createArray(arr.map(function (m) {
+        return m.toArray();
+      })));
+    } // TODO implement this properly for SparseMatrix
+
+  });
+
+  function _createArray(arr) {
+    if (arr.length === 0) throw new TypeError('At least one column is needed to construct a matrix.');
+    var N = checkVectorTypeAndReturnLength(arr[0]); // create an array with empty rows
+
+    var result = [];
+
+    for (var i = 0; i < N; i++) {
+      result[i] = [];
+    } // loop columns
+
+
+    var _iterator = _createForOfIteratorHelper(arr),
+        _step;
+
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var col = _step.value;
+        var colLength = checkVectorTypeAndReturnLength(col);
+
+        if (colLength !== N) {
+          throw new TypeError('The vectors had different length: ' + (N | 0) + ' ≠ ' + (colLength | 0));
+        }
+
+        var f = flatten(col); // push a value to each row
+
+        for (var _i = 0; _i < N; _i++) {
+          result[_i].push(f[_i]);
+        }
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+
+    return result;
+  }
+
+  function checkVectorTypeAndReturnLength(vec) {
+    var s = size(vec);
+
+    if (s.length === 1) {
+      // 1D vector
+      return s[0];
+    } else if (s.length === 2) {
+      // 2D vector
+      if (s[0] === 1) {
+        // row vector
+        return s[1];
+      } else if (s[1] === 1) {
+        // col vector
+        return s[0];
+      } else {
+        throw new TypeError('At least one of the arguments is not a vector.');
+      }
+    } else {
+      throw new TypeError('Only one- or two-dimensional vectors are supported.');
+    }
+  }
+});
+exports.createMatrixFromColumns = createMatrixFromColumns;

package/lib/cjs/function/matrix/matrixFromFunction.js

@@ -0,0 +1,85 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createMatrixFromFunction = void 0;
+
+var _factory = require("../../utils/factory.js");
+
+var name = 'matrixFromFunction';
+var dependencies = ['typed', 'matrix', 'isZero'];
+var createMatrixFromFunction = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
+  var typed = _ref.typed,
+      matrix = _ref.matrix,
+      isZero = _ref.isZero;
+
+  /**
+   * Create a matrix by evaluating a generating function at each index.
+   * The simplest overload returns a multi-dimensional array as long as `size` is an array.
+   * Passing `size` as a Matrix or specifying a `format` will result in returning a Matrix.
+   *
+   * Syntax:
+   *
+   *    math.matrixFromFunction(size, fn)
+   *    math.matrixFromFunction(size, fn, format)
+   *    math.matrixFromFunction(size, fn, format, datatype)
+   *    math.matrixFromFunction(size, format, fn)
+   *    math.matrixFromFunction(size, format, datatype, fn)
+   *
+   * Examples:
+   *
+   *    math.matrixFromFunction([3,3], i => i[0] - i[1]) // an antisymmetric matrix
+   *    math.matrixFromFunction([100, 100], 'sparse', i => i[0] - i[1] === 1 ? 4 : 0) // a sparse subdiagonal matrix
+   *    math.matrixFromFunction([5], i => math.random()) // a random vector
+   *
+   * See also:
+   *
+   *    matrix, zeros
+   *
+   * @param {Array | Matrix} size   The size of the matrix to be created
+   * @param {function} fn           Callback function invoked for every entry in the matrix
+   * @param {string} [format]       The Matrix storage format, either `'dense'` or `'sparse'`
+   * @param {string} [datatype]     Type of the values
+   * @return {Array | Matrix} Returns the created matrix
+   */
+  return typed(name, {
+    'Array | Matrix, function, string, string': function ArrayMatrixFunctionStringString(size, fn, format, datatype) {
+      return _create(size, fn, format, datatype);
+    },
+    'Array | Matrix, function, string': function ArrayMatrixFunctionString(size, fn, format) {
+      return _create(size, fn, format);
+    },
+    'Matrix, function': function MatrixFunction(size, fn) {
+      return _create(size, fn, 'dense');
+    },
+    'Array, function': function ArrayFunction(size, fn) {
+      return _create(size, fn, 'dense').toArray();
+    },
+    'Array | Matrix, string, function': function ArrayMatrixStringFunction(size, format, fn) {
+      return _create(size, fn, format);
+    },
+    'Array | Matrix, string, string, function': function ArrayMatrixStringStringFunction(size, format, datatype, fn) {
+      return _create(size, fn, format, datatype);
+    }
+  });
+
+  function _create(size, fn, format, datatype) {
+    var m;
+
+    if (datatype !== undefined) {
+      m = matrix(format, datatype);
+    } else {
+      m = matrix(format);
+    }
+
+    m.resize(size);
+    m.forEach(function (_, index) {
+      var val = fn(index);
+      if (isZero(val)) return;
+      m.set(index, val);
+    });
+    return m;
+  }
+});
+exports.createMatrixFromFunction = createMatrixFromFunction;

package/lib/cjs/function/matrix/matrixFromRows.js

@@ -0,0 +1,108 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createMatrixFromRows = void 0;
+
+var _factory = require("../../utils/factory.js");
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+var name = 'matrixFromRows';
+var dependencies = ['typed', 'matrix', 'flatten', 'size'];
+var createMatrixFromRows = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
+  var typed = _ref.typed,
+      matrix = _ref.matrix,
+      flatten = _ref.flatten,
+      size = _ref.size;
+
+  /**
+   * Create a dense matrix from vectors as individual rows.
+   * If you pass column vectors, they will be transposed (but not conjugated!)
+   *
+   * Syntax:
+   *
+   *    math.matrixFromRows(...arr)
+   *    math.matrixFromRows(row1, row2)
+   *    math.matrixFromRows(row1, row2, row3)
+   *
+   * Examples:
+   *
+   *    math.matrixFromRows([1, 2, 3], [[4],[5],[6]])
+   *    math.matrixFromRows(...vectors)
+   *
+   * See also:
+   *
+   *    matrix, matrixFromColumns, matrixFromFunction, zeros
+   *
+   * @param {... Array | Matrix} rows  Multiple rows
+   * @return { number[][] | Matrix } if at least one of the arguments is an array, an array will be returned
+   */
+  return typed(name, {
+    '...Array': function Array(arr) {
+      return _createArray(arr);
+    },
+    '...Matrix': function Matrix(arr) {
+      return matrix(_createArray(arr.map(function (m) {
+        return m.toArray();
+      })));
+    } // TODO implement this properly for SparseMatrix
+
+  });
+
+  function _createArray(arr) {
+    if (arr.length === 0) throw new TypeError('At least one row is needed to construct a matrix.');
+    var N = checkVectorTypeAndReturnLength(arr[0]);
+    var result = [];
+
+    var _iterator = _createForOfIteratorHelper(arr),
+        _step;
+
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var row = _step.value;
+        var rowLength = checkVectorTypeAndReturnLength(row);
+
+        if (rowLength !== N) {
+          throw new TypeError('The vectors had different length: ' + (N | 0) + ' ≠ ' + (rowLength | 0));
+        }
+
+        result.push(flatten(row));
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+
+    return result;
+  }
+
+  function checkVectorTypeAndReturnLength(vec) {
+    var s = size(vec);
+
+    if (s.length === 1) {
+      // 1D vector
+      return s[0];
+    } else if (s.length === 2) {
+      // 2D vector
+      if (s[0] === 1) {
+        // row vector
+        return s[1];
+      } else if (s[1] === 1) {
+        // col vector
+        return s[0];
+      } else {
+        throw new TypeError('At least one of the arguments is not a vector.');
+      }
+    } else {
+      throw new TypeError('Only one- or two-dimensional vectors are supported.');
+    }
+  }
+});
+exports.createMatrixFromRows = createMatrixFromRows;

package/lib/cjs/function/probability/pickRandom.js

@@ -66,7 +66,7 @@ var createPickRandom = /* #__PURE__ */(0, _factory.factory)(name, dependencies,
    */
 
 
-  return typed({
+  return typed(name, {
     'Array | Matrix': function ArrayMatrix(possibles) {
       return _pickRandom(possibles, {});
     },

package/lib/cjs/function/probability/util/seededRNG.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -7,8 +9,6 @@ exports.createRng = createRng;
 
 var _seedrandom = _interopRequireDefault(require("seedrandom"));
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 var singletonRandom = /* #__PURE__ */(0, _seedrandom["default"])(Date.now());
 
 function createRng(randomSeed) {

package/lib/cjs/function/relational/compareNatural.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -11,8 +13,6 @@ var _is = require("../../utils/is.js");
 
 var _factory = require("../../utils/factory.js");
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 var name = 'compareNatural';
 var dependencies = ['typed', 'compare'];
 var createCompareNatural = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {

package/lib/cjs/header.js

@@ -6,8 +6,8 @@
  * It features real and complex numbers, units, matrices, a large set of
  * mathematical functions, and a flexible expression parser.
  *
- * @version 9.3.2
- * @date    2021-04-12
+ * @version 9.4.0
+ * @date    2021-05-16
  *
  * @license
  * Copyright (C) 2013-2021 Jos de Jong <wjosdejong@gmail.com>

package/lib/cjs/plain/bignumber/index.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -24,8 +26,6 @@ Object.keys(_arithmetic).forEach(function (key) {
   });
 });
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 // TODO: this is ugly. Instead, be able to pass your own isBigNumber function to typed?
 var BigNumber = _decimal["default"].clone();
 

package/lib/cjs/type/bignumber/BigNumber.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -9,8 +11,6 @@ var _decimal = _interopRequireDefault(require("decimal.js"));
 
 var _factory = require("../../utils/factory.js");
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 var name = 'BigNumber';
 var dependencies = ['?on', 'config'];
 var createBigNumberClass = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {

package/lib/cjs/type/complex/Complex.js

@@ -1,10 +1,14 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createComplexClass = void 0;
 
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+
 var _complex = _interopRequireDefault(require("complex.js"));
 
 var _number = require("../../utils/number.js");
@@ -13,10 +17,6 @@ var _is = require("../../utils/is.js");
 
 var _factory = require("../../utils/factory.js");
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
-
 var name = 'Complex';
 var dependencies = [];
 var createComplexClass = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function () {
@@ -133,7 +133,7 @@ var createComplexClass = /* #__PURE__ */(0, _factory.factory)(name, dependencies
         {
           var arg = arguments[0];
 
-          if (_typeof(arg) === 'object') {
+          if ((0, _typeof2["default"])(arg) === 'object') {
             return (0, _complex["default"])(arg);
           } else {
             throw new TypeError('Input has to be an object with r and phi keys.');

package/lib/cjs/type/fraction/Fraction.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -9,8 +11,6 @@ var _fraction = _interopRequireDefault(require("fraction.js"));
 
 var _factory = require("../../utils/factory.js");
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 var name = 'Fraction';
 var dependencies = [];
 var createFractionClass = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function () {

package/lib/cjs/type/matrix/DenseMatrix.js

@@ -1,10 +1,14 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.createDenseMatrixClass = void 0;
 
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
 var _is = require("../../utils/is.js");
 
 var _array = require("../../utils/array.js");
@@ -19,6 +23,12 @@ var _DimensionError = require("../../error/DimensionError.js");
 
 var _factory = require("../../utils/factory.js");
 
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
 var name = 'DenseMatrix';
 var dependencies = ['Matrix'];
 var createDenseMatrixClass = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
@@ -27,6 +37,7 @@ var createDenseMatrixClass = /* #__PURE__ */(0, _factory.factory)(name, dependen
   /**
    * Dense Matrix implementation. A regular, dense matrix, supporting multi-dimensional matrices. This is the default matrix type.
    * @class DenseMatrix
+   * @enum {{ value, index: number[] }}
    */
   function DenseMatrix(data, datatype) {
     if (!(this instanceof DenseMatrix)) {
@@ -631,6 +642,133 @@ var createDenseMatrixClass = /* #__PURE__ */(0, _factory.factory)(name, dependen
 
     recurse(this._data, []);
   };
+  /**
+   * Iterate over the matrix elements
+   * @return {Iterable<{ value, index: number[] }>}
+   */
+
+
+  DenseMatrix.prototype[Symbol.iterator] = /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+    var recurse;
+    return _regenerator["default"].wrap(function _callee$(_context2) {
+      while (1) {
+        switch (_context2.prev = _context2.next) {
+          case 0:
+            recurse = /*#__PURE__*/_regenerator["default"].mark(function recurse(value, index) {
+              var i;
+              return _regenerator["default"].wrap(function recurse$(_context) {
+                while (1) {
+                  switch (_context.prev = _context.next) {
+                    case 0:
+                      if (!(0, _is.isArray)(value)) {
+                        _context.next = 9;
+                        break;
+                      }
+
+                      i = 0;
+
+                    case 2:
+                      if (!(i < value.length)) {
+                        _context.next = 7;
+                        break;
+                      }
+
+                      return _context.delegateYield(recurse(value[i], index.concat(i)), "t0", 4);
+
+                    case 4:
+                      i++;
+                      _context.next = 2;
+                      break;
+
+                    case 7:
+                      _context.next = 11;
+                      break;
+
+                    case 9:
+                      _context.next = 11;
+                      return {
+                        value: value,
+                        index: index
+                      };
+
+                    case 11:
+                    case "end":
+                      return _context.stop();
+                  }
+                }
+              }, recurse);
+            });
+            return _context2.delegateYield(recurse(this._data, []), "t0", 2);
+
+          case 2:
+          case "end":
+            return _context2.stop();
+        }
+      }
+    }, _callee, this);
+  });
+  /**
+   * Returns an array containing the rows of a 2D matrix
+   * @returns {Array<Matrix>}
+   */
+
+  DenseMatrix.prototype.rows = function () {
+    var result = [];
+    var s = this.size();
+
+    if (s.length !== 2) {
+      throw new TypeError('Rows can only be returned for a 2D matrix.');
+    }
+
+    var data = this._data;
+
+    var _iterator = _createForOfIteratorHelper(data),
+        _step;
+
+    try {
+      for (_iterator.s(); !(_step = _iterator.n()).done;) {
+        var row = _step.value;
+        result.push(new DenseMatrix([row], this._datatype));
+      }
+    } catch (err) {
+      _iterator.e(err);
+    } finally {
+      _iterator.f();
+    }
+
+    return result;
+  };
+  /**
+   * Returns an array containing the columns of a 2D matrix
+   * @returns {Array<Matrix>}
+   */
+
+
+  DenseMatrix.prototype.columns = function () {
+    var _this = this;
+
+    var result = [];
+    var s = this.size();
+
+    if (s.length !== 2) {
+      throw new TypeError('Rows can only be returned for a 2D matrix.');
+    }
+
+    var data = this._data;
+
+    var _loop = function _loop(i) {
+      var col = data.map(function (row) {
+        return [row[i]];
+      });
+      result.push(new DenseMatrix(col, _this._datatype));
+    };
+
+    for (var i = 0; i < s[1]; i++) {
+      _loop(i);
+    }
+
+    return result;
+  };
   /**
    * Create an Array with a copy of the data of the DenseMatrix
    * @memberof DenseMatrix

package/lib/cjs/type/matrix/Matrix.js

@@ -207,6 +207,16 @@ var createMatrixClass = /* #__PURE__ */(0, _factory.factory)(name, dependencies,
     // must be implemented by each of the Matrix implementations
     throw new Error('Cannot invoke forEach on a Matrix interface');
   };
+  /**
+   * Iterate over the matrix elements
+   * @return {Iterable<{ value, index: number[] }>}
+   */
+
+
+  Matrix.prototype[Symbol.iterator] = function () {
+    // must be implemented by each of the Matrix implementations
+    throw new Error('Cannot iterate a Matrix interface');
+  };
   /**
    * Create an Array with a copy of the data of the Matrix
    * @returns {Array} array