mathjs 8.1.0 → 12.2.1

package/lib/esm/type/matrix/MatrixIndex.js

@@ -1,14 +1,14 @@
-import { isMatrix, isRange } from '../../utils/is.js';
+import { isArray, isMatrix, isRange } from '../../utils/is.js';
 import { clone } from '../../utils/object.js';
 import { isInteger } from '../../utils/number.js';
 import { factory } from '../../utils/factory.js';
 var name = 'Index';
-var dependencies = ['ImmutableDenseMatrix'];
-export var createIndexClass = /* #__PURE__ */factory(name, dependencies, (_ref) => {
+var dependencies = ['ImmutableDenseMatrix', 'getMatrixDataType'];
+export var createIndexClass = /* #__PURE__ */factory(name, dependencies, _ref => {
   var {
-    ImmutableDenseMatrix
+    ImmutableDenseMatrix,
+    getMatrixDataType
   } = _ref;
-
   /**
    * Create an index. An Index can store ranges and sets for multiple dimensions.
    * Matrix.get, Matrix.set, and math.subset accept an Index as input.
@@ -21,7 +21,9 @@ export var createIndexClass = /* #__PURE__ */factory(name, dependencies, (_ref)
    *     A string (containing a name of an object property)
    *     An instance of Range
    *     An Array with the Set values
+   *     An Array with Booleans
    *     A Matrix with the Set values
+   *     A Matrix with Booleans
    *
    * The parameters start, end, and step must be integer numbers.
    *
@@ -33,27 +35,32 @@ export var createIndexClass = /* #__PURE__ */factory(name, dependencies, (_ref)
     if (!(this instanceof Index)) {
       throw new SyntaxError('Constructor must be called with the new operator');
     }
-
     this._dimensions = [];
+    this._sourceSize = [];
     this._isScalar = true;
-
     for (var i = 0, ii = arguments.length; i < ii; i++) {
       var arg = arguments[i];
-
+      var argIsArray = isArray(arg);
+      var argIsMatrix = isMatrix(arg);
+      var sourceSize = null;
       if (isRange(arg)) {
         this._dimensions.push(arg);
-
         this._isScalar = false;
-      } else if (Array.isArray(arg) || isMatrix(arg)) {
+      } else if (argIsArray || argIsMatrix) {
         // create matrix
-        var m = _createImmutableMatrix(arg.valueOf());
-
-        this._dimensions.push(m); // size
-
-
-        var size = m.size(); // scalar
-
-        if (size.length !== 1 || size[0] !== 1) {
+        var m = void 0;
+        if (getMatrixDataType(arg) === 'boolean') {
+          if (argIsArray) m = _createImmutableMatrix(_booleansArrayToNumbersForIndex(arg).valueOf());
+          if (argIsMatrix) m = _createImmutableMatrix(_booleansArrayToNumbersForIndex(arg._data).valueOf());
+          sourceSize = arg.valueOf().length;
+        } else {
+          m = _createImmutableMatrix(arg.valueOf());
+        }
+        this._dimensions.push(m);
+        // size
+        var size = m.size();
+        // scalar
+        if (size.length !== 1 || size[0] !== 1 || sourceSize !== null) {
           this._isScalar = false;
         }
       } else if (typeof arg === 'number') {
@@ -63,42 +70,41 @@ export var createIndexClass = /* #__PURE__ */factory(name, dependencies, (_ref)
         this._dimensions.push(arg);
       } else {
         throw new TypeError('Dimension must be an Array, Matrix, number, string, or Range');
-      } // TODO: implement support for wildcard '*'
-
+      }
+      this._sourceSize.push(sourceSize);
+      // TODO: implement support for wildcard '*'
     }
   }
+
   /**
    * Attach type information
    */
-
-
   Index.prototype.type = 'Index';
   Index.prototype.isIndex = true;
-
   function _createImmutableMatrix(arg) {
     // loop array elements
     for (var i = 0, l = arg.length; i < l; i++) {
       if (typeof arg[i] !== 'number' || !isInteger(arg[i])) {
         throw new TypeError('Index parameters must be positive integer numbers');
       }
-    } // create matrix
-
-
+    }
+    // create matrix
     return new ImmutableDenseMatrix(arg);
   }
+
   /**
    * Create a clone of the index
    * @memberof Index
    * @return {Index} clone
    */
-
-
   Index.prototype.clone = function () {
     var index = new Index();
     index._dimensions = clone(this._dimensions);
     index._isScalar = this._isScalar;
+    index._sourceSize = this._sourceSize;
     return index;
   };
+
   /**
    * Create an index from an array with ranges/numbers
    * @memberof Index
@@ -106,64 +112,54 @@ export var createIndexClass = /* #__PURE__ */factory(name, dependencies, (_ref)
    * @return {Index} index
    * @private
    */
-
-
   Index.create = function (ranges) {
     var index = new Index();
     Index.apply(index, ranges);
     return index;
   };
+
   /**
    * Retrieve the size of the index, the number of elements for each dimension.
    * @memberof Index
    * @returns {number[]} size
    */
-
-
   Index.prototype.size = function () {
     var size = [];
-
     for (var i = 0, ii = this._dimensions.length; i < ii; i++) {
       var d = this._dimensions[i];
       size[i] = typeof d === 'string' ? 1 : d.size()[0];
     }
-
     return size;
   };
+
   /**
    * Get the maximum value for each of the indexes ranges.
    * @memberof Index
    * @returns {number[]} max
    */
-
-
   Index.prototype.max = function () {
     var values = [];
-
     for (var i = 0, ii = this._dimensions.length; i < ii; i++) {
       var range = this._dimensions[i];
       values[i] = typeof range === 'string' ? range : range.max();
     }
-
     return values;
   };
+
   /**
    * Get the minimum value for each of the indexes ranges.
    * @memberof Index
    * @returns {number[]} min
    */
-
-
   Index.prototype.min = function () {
     var values = [];
-
     for (var i = 0, ii = this._dimensions.length; i < ii; i++) {
       var range = this._dimensions[i];
       values[i] = typeof range === 'string' ? range : range.min();
     }
-
     return values;
   };
+
   /**
    * Loop over each of the ranges of the index
    * @memberof Index
@@ -171,43 +167,39 @@ export var createIndexClass = /* #__PURE__ */factory(name, dependencies, (_ref)
    *                              argument, the dimension as second, and the
    *                              index object as third.
    */
-
-
   Index.prototype.forEach = function (callback) {
     for (var i = 0, ii = this._dimensions.length; i < ii; i++) {
       callback(this._dimensions[i], i, this);
     }
   };
+
   /**
    * Retrieve the dimension for the given index
    * @memberof Index
    * @param {Number} dim                  Number of the dimension
    * @returns {Range | null} range
    */
-
-
   Index.prototype.dimension = function (dim) {
     return this._dimensions[dim] || null;
   };
+
   /**
    * Test whether this index contains an object property
    * @returns {boolean} Returns true if the index is an object property
    */
-
-
   Index.prototype.isObjectProperty = function () {
     return this._dimensions.length === 1 && typeof this._dimensions[0] === 'string';
   };
+
   /**
    * Returns the object property name when the Index holds a single object property,
    * else returns null
    * @returns {string | null}
    */
-
-
   Index.prototype.getObjectProperty = function () {
     return this.isObjectProperty() ? this._dimensions[0] : null;
   };
+
   /**
    * Test whether this index contains only a single value.
    *
@@ -216,73 +208,64 @@ export var createIndexClass = /* #__PURE__ */factory(name, dependencies, (_ref)
    * @memberof Index
    * @return {boolean} isScalar
    */
-
-
   Index.prototype.isScalar = function () {
     return this._isScalar;
   };
+
   /**
    * Expand the Index into an array.
    * For example new Index([0,3], [2,7]) returns [[0,1,2], [2,3,4,5,6]]
    * @memberof Index
    * @returns {Array} array
    */
-
-
   Index.prototype.toArray = function () {
     var array = [];
-
     for (var i = 0, ii = this._dimensions.length; i < ii; i++) {
       var dimension = this._dimensions[i];
       array.push(typeof dimension === 'string' ? dimension : dimension.toArray());
     }
-
     return array;
   };
+
   /**
    * Get the primitive value of the Index, a two dimensional array.
    * Equivalent to Index.toArray().
    * @memberof Index
    * @returns {Array} array
    */
-
-
   Index.prototype.valueOf = Index.prototype.toArray;
+
   /**
    * Get the string representation of the index, for example '[2:6]' or '[0:2:10, 4:7, [1,2,3]]'
    * @memberof Index
    * @returns {String} str
    */
-
   Index.prototype.toString = function () {
     var strings = [];
-
     for (var i = 0, ii = this._dimensions.length; i < ii; i++) {
       var dimension = this._dimensions[i];
-
       if (typeof dimension === 'string') {
         strings.push(JSON.stringify(dimension));
       } else {
         strings.push(dimension.toString());
       }
     }
-
     return '[' + strings.join(', ') + ']';
   };
+
   /**
    * Get a JSON representation of the Index
    * @memberof Index
    * @returns {Object} Returns a JSON object structured as:
    *                   `{"mathjs": "Index", "ranges": [{"mathjs": "Range", start: 0, end: 10, step:1}, ...]}`
    */
-
-
   Index.prototype.toJSON = function () {
     return {
       mathjs: 'Index',
       dimensions: this._dimensions
     };
   };
+
   /**
    * Instantiate an Index from a JSON object
    * @memberof Index
@@ -290,13 +273,26 @@ export var createIndexClass = /* #__PURE__ */factory(name, dependencies, (_ref)
    *                     `{"mathjs": "Index", "dimensions": [{"mathjs": "Range", start: 0, end: 10, step:1}, ...]}`
    * @return {Index}
    */
-
-
   Index.fromJSON = function (json) {
     return Index.create(json.dimensions);
   };
-
   return Index;
 }, {
   isClass: true
-});
+});
+
+/**
+ * Receives an array of booleans and returns an array of Numbers for Index
+ * @param {Array} booleanArrayIndex An array of booleans
+ * @return {Array} A set of numbers ready for index
+ */
+function _booleansArrayToNumbersForIndex(booleanArrayIndex) {
+  // gets an array of booleans and returns an array of numbers
+  var indexOfNumbers = [];
+  booleanArrayIndex.forEach((bool, idx) => {
+    if (bool) {
+      indexOfNumbers.push(idx);
+    }
+  });
+  return indexOfNumbers;
+}

package/lib/esm/type/matrix/Range.js

@@ -39,11 +39,9 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
     if (!(this instanceof Range)) {
       throw new SyntaxError('Constructor must be called with the new operator');
     }
-
     var hasStart = start !== null && start !== undefined;
     var hasEnd = end !== null && end !== undefined;
     var hasStep = step !== null && step !== undefined;
-
     if (hasStart) {
       if (isBigNumber(start)) {
         start = start.toNumber();
@@ -51,7 +49,6 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
         throw new TypeError('Parameter start must be a number');
       }
     }
-
     if (hasEnd) {
       if (isBigNumber(end)) {
         end = end.toNumber();
@@ -59,7 +56,6 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
         throw new TypeError('Parameter end must be a number');
       }
     }
-
     if (hasStep) {
       if (isBigNumber(step)) {
         step = step.toNumber();
@@ -67,18 +63,17 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
         throw new TypeError('Parameter step must be a number');
       }
     }
-
     this.start = hasStart ? parseFloat(start) : 0;
     this.end = hasEnd ? parseFloat(end) : 0;
     this.step = hasStep ? parseFloat(step) : 1;
   }
+
   /**
    * Attach type information
    */
-
-
   Range.prototype.type = 'Range';
   Range.prototype.isRange = true;
+
   /**
    * Parse a string into a range,
    * The string contains the start, optional step, and end, separated by a colon.
@@ -88,12 +83,10 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
    * @param {string} str
    * @return {Range | null} range
    */
-
   Range.parse = function (str) {
     if (typeof str !== 'string') {
       return null;
     }
-
     var args = str.split(':');
     var nums = args.map(function (arg) {
       return parseFloat(arg);
@@ -101,68 +94,57 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
     var invalid = nums.some(function (num) {
       return isNaN(num);
     });
-
     if (invalid) {
       return null;
     }
-
     switch (nums.length) {
       case 2:
         return new Range(nums[0], nums[1]);
-
       case 3:
         return new Range(nums[0], nums[2], nums[1]);
-
       default:
         return null;
     }
   };
+
   /**
    * Create a clone of the range
    * @return {Range} clone
    */
-
-
   Range.prototype.clone = function () {
     return new Range(this.start, this.end, this.step);
   };
+
   /**
    * Retrieve the size of the range.
    * Returns an array containing one number, the number of elements in the range.
    * @memberof Range
    * @returns {number[]} size
    */
-
-
   Range.prototype.size = function () {
     var len = 0;
     var start = this.start;
     var step = this.step;
     var end = this.end;
     var diff = end - start;
-
     if (sign(step) === sign(diff)) {
       len = Math.ceil(diff / step);
     } else if (diff === 0) {
       len = 0;
     }
-
     if (isNaN(len)) {
       len = 0;
     }
-
     return [len];
   };
+
   /**
    * Calculate the minimum value in the range
    * @memberof Range
    * @return {number | undefined} min
    */
-
-
   Range.prototype.min = function () {
     var size = this.size()[0];
-
     if (size > 0) {
       if (this.step > 0) {
         // positive step
@@ -175,16 +157,14 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
       return undefined;
     }
   };
+
   /**
    * Calculate the maximum value in the range
    * @memberof Range
    * @return {number | undefined} max
    */
-
-
   Range.prototype.max = function () {
     var size = this.size()[0];
-
     if (size > 0) {
       if (this.step > 0) {
         // positive step
@@ -197,6 +177,7 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
       return undefined;
     }
   };
+
   /**
    * Execute a callback function for each value in the range.
    * @memberof Range
@@ -204,14 +185,11 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
    *                              parameters: the value of the element, the index
    *                              of the element, and the Range being traversed.
    */
-
-
   Range.prototype.forEach = function (callback) {
     var x = this.start;
     var step = this.step;
     var end = this.end;
     var i = 0;
-
     if (step > 0) {
       while (x < end) {
         callback(x, [i], this);
@@ -226,6 +204,7 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
       }
     }
   };
+
   /**
    * Execute a callback function for each value in the Range, and return the
    * results as an array
@@ -235,8 +214,6 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
    *                              of the element, and the Matrix being traversed.
    * @returns {Array} array
    */
-
-
   Range.prototype.map = function (callback) {
     var array = [];
     this.forEach(function (value, index, obj) {
@@ -244,13 +221,12 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
     });
     return array;
   };
+
   /**
    * Create an Array with a copy of the Ranges data
    * @memberof Range
    * @returns {Array} array
    */
-
-
   Range.prototype.toArray = function () {
     var array = [];
     this.forEach(function (value, index) {
@@ -258,17 +234,17 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
     });
     return array;
   };
+
   /**
    * Get the primitive value of the Range, a one dimensional array
    * @memberof Range
    * @returns {Array} array
    */
-
-
   Range.prototype.valueOf = function () {
     // TODO: implement a caching mechanism for range.valueOf()
     return this.toArray();
   };
+
   /**
    * Get a string representation of the range, with optional formatting options.
    * Output is formatted as 'start:step:end', for example '2:6' or '0:0.2:11'
@@ -279,36 +255,30 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
    *                                                options.
    * @returns {string} str
    */
-
-
   Range.prototype.format = function (options) {
     var str = format(this.start, options);
-
     if (this.step !== 1) {
       str += ':' + format(this.step, options);
     }
-
     str += ':' + format(this.end, options);
     return str;
   };
+
   /**
    * Get a string representation of the range.
    * @memberof Range
    * @returns {string}
    */
-
-
   Range.prototype.toString = function () {
     return this.format();
   };
+
   /**
    * Get a JSON representation of the range
    * @memberof Range
    * @returns {Object} Returns a JSON object structured as:
    *                   `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`
    */
-
-
   Range.prototype.toJSON = function () {
     return {
       mathjs: 'Range',
@@ -317,6 +287,7 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
       step: this.step
     };
   };
+
   /**
    * Instantiate a Range from a JSON object
    * @memberof Range
@@ -324,12 +295,9 @@ export var createRangeClass = /* #__PURE__ */factory(name, dependencies, () => {
    *                      `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`
    * @return {Range}
    */
-
-
   Range.fromJSON = function (json) {
     return new Range(json.start, json.end, json.step);
   };
-
   return Range;
 }, {
   isClass: true