ml-matrix 6.5.3 → 6.8.1

package/src/matrix.js

@@ -29,6 +29,7 @@ import {
   checkColumnVector,
   checkRange,
   checkIndices,
+  checkNonEmpty,
 } from './util';
 
 export class AbstractMatrix {
@@ -219,6 +220,10 @@ export class AbstractMatrix {
     return this.rows === this.columns;
   }
 
+  isEmpty() {
+    return this.rows === 0 || this.columns === 0;
+  }
+
   isSymmetric() {
     if (this.isSquare()) {
       for (let i = 0; i < this.rows; i++) {
@@ -556,6 +561,9 @@ export class AbstractMatrix {
   }
 
   max() {
+    if (this.isEmpty()) {
+      return NaN;
+    }
     let v = this.get(0, 0);
     for (let i = 0; i < this.rows; i++) {
       for (let j = 0; j < this.columns; j++) {
@@ -568,6 +576,7 @@ export class AbstractMatrix {
   }
 
   maxIndex() {
+    checkNonEmpty(this);
     let v = this.get(0, 0);
     let idx = [0, 0];
     for (let i = 0; i < this.rows; i++) {
@@ -583,6 +592,9 @@ export class AbstractMatrix {
   }
 
   min() {
+    if (this.isEmpty()) {
+      return NaN;
+    }
     let v = this.get(0, 0);
     for (let i = 0; i < this.rows; i++) {
       for (let j = 0; j < this.columns; j++) {
@@ -595,6 +607,7 @@ export class AbstractMatrix {
   }
 
   minIndex() {
+    checkNonEmpty(this);
     let v = this.get(0, 0);
     let idx = [0, 0];
     for (let i = 0; i < this.rows; i++) {
@@ -611,6 +624,9 @@ export class AbstractMatrix {
 
   maxRow(row) {
     checkRowIndex(this, row);
+    if (this.isEmpty()) {
+      return NaN;
+    }
     let v = this.get(row, 0);
     for (let i = 1; i < this.columns; i++) {
       if (this.get(row, i) > v) {
@@ -622,6 +638,7 @@ export class AbstractMatrix {
 
   maxRowIndex(row) {
     checkRowIndex(this, row);
+    checkNonEmpty(this);
     let v = this.get(row, 0);
     let idx = [row, 0];
     for (let i = 1; i < this.columns; i++) {
@@ -635,6 +652,9 @@ export class AbstractMatrix {
 
   minRow(row) {
     checkRowIndex(this, row);
+    if (this.isEmpty()) {
+      return NaN;
+    }
     let v = this.get(row, 0);
     for (let i = 1; i < this.columns; i++) {
       if (this.get(row, i) < v) {
@@ -646,6 +666,7 @@ export class AbstractMatrix {
 
   minRowIndex(row) {
     checkRowIndex(this, row);
+    checkNonEmpty(this);
     let v = this.get(row, 0);
     let idx = [row, 0];
     for (let i = 1; i < this.columns; i++) {
@@ -659,6 +680,9 @@ export class AbstractMatrix {
 
   maxColumn(column) {
     checkColumnIndex(this, column);
+    if (this.isEmpty()) {
+      return NaN;
+    }
     let v = this.get(0, column);
     for (let i = 1; i < this.rows; i++) {
       if (this.get(i, column) > v) {
@@ -670,6 +694,7 @@ export class AbstractMatrix {
 
   maxColumnIndex(column) {
     checkColumnIndex(this, column);
+    checkNonEmpty(this);
     let v = this.get(0, column);
     let idx = [0, column];
     for (let i = 1; i < this.rows; i++) {
@@ -683,6 +708,9 @@ export class AbstractMatrix {
 
   minColumn(column) {
     checkColumnIndex(this, column);
+    if (this.isEmpty()) {
+      return NaN;
+    }
     let v = this.get(0, column);
     for (let i = 1; i < this.rows; i++) {
       if (this.get(i, column) < v) {
@@ -694,6 +722,7 @@ export class AbstractMatrix {
 
   minColumnIndex(column) {
     checkColumnIndex(this, column);
+    checkNonEmpty(this);
     let v = this.get(0, column);
     let idx = [0, column];
     for (let i = 1; i < this.rows; i++) {
@@ -1012,7 +1041,9 @@ export class AbstractMatrix {
     let newMatrix = new Matrix(this.rows, this.columns);
     for (let i = 0; i < this.rows; i++) {
       const row = this.getRow(i);
-      rescale(row, { min, max, output: row });
+      if (row.length > 0) {
+        rescale(row, { min, max, output: row });
+      }
       newMatrix.setRow(i, row);
     }
     return newMatrix;
@@ -1029,11 +1060,13 @@ export class AbstractMatrix {
     let newMatrix = new Matrix(this.rows, this.columns);
     for (let i = 0; i < this.columns; i++) {
       const column = this.getColumn(i);
-      rescale(column, {
-        min: min,
-        max: max,
-        output: column,
-      });
+      if (column.length) {
+        rescale(column, {
+          min: min,
+          max: max,
+          output: column,
+        });
+      }
       newMatrix.setColumn(i, column);
     }
     return newMatrix;
@@ -1086,6 +1119,18 @@ export class AbstractMatrix {
     return result;
   }
 
+  kroneckerSum(other) {
+    other = Matrix.checkMatrix(other);
+    if (!this.isSquare() || !other.isSquare()) {
+      throw new Error('Kronecker Sum needs two Square Matrices');
+    }
+    let m = this.rows;
+    let n = other.rows;
+    let AxI = this.kroneckerProduct(Matrix.eye(n, n));
+    let IxB = Matrix.eye(m, m).kroneckerProduct(other);
+    return AxI.add(IxB);
+  }
+
   transpose() {
     let result = new Matrix(this.columns, this.rows);
     for (let i = 0; i < this.rows; i++) {
@@ -1176,6 +1221,9 @@ export class AbstractMatrix {
 
   setSubMatrix(matrix, startRow, startColumn) {
     matrix = Matrix.checkMatrix(matrix);
+    if (matrix.isEmpty()) {
+      return this;
+    }
     let endRow = startRow + matrix.rows - 1;
     let endColumn = startColumn + matrix.columns - 1;
     checkRange(this, startRow, endRow, startColumn, endColumn);
@@ -1404,9 +1452,8 @@ export class AbstractMatrix {
 
 AbstractMatrix.prototype.klass = 'Matrix';
 if (typeof Symbol !== 'undefined') {
-  AbstractMatrix.prototype[
-    Symbol.for('nodejs.util.inspect.custom')
-  ] = inspectMatrix;
+  AbstractMatrix.prototype[Symbol.for('nodejs.util.inspect.custom')] =
+    inspectMatrix;
 }
 
 function compareNumbers(a, b) {
@@ -1429,10 +1476,10 @@ export default class Matrix extends AbstractMatrix {
     if (Matrix.isMatrix(nRows)) {
       // eslint-disable-next-line no-constructor-return
       return nRows.clone();
-    } else if (Number.isInteger(nRows) && nRows > 0) {
+    } else if (Number.isInteger(nRows) && nRows >= 0) {
       // Create an empty matrix
       this.data = [];
-      if (Number.isInteger(nColumns) && nColumns > 0) {
+      if (Number.isInteger(nColumns) && nColumns >= 0) {
         for (let i = 0; i < nRows; i++) {
           this.data.push(new Float64Array(nColumns));
         }
@@ -1443,8 +1490,8 @@ export default class Matrix extends AbstractMatrix {
       // Copy the values from the 2D array
       const arrayData = nRows;
       nRows = arrayData.length;
-      nColumns = arrayData[0].length;
-      if (typeof nColumns !== 'number' || nColumns === 0) {
+      nColumns = nRows ? arrayData[0].length : 0;
+      if (typeof nColumns !== 'number') {
         throw new TypeError(
           'Data must be a 2D array with at least one element',
         );
@@ -1476,9 +1523,6 @@ export default class Matrix extends AbstractMatrix {
 
   removeRow(index) {
     checkRowIndex(this, index);
-    if (this.rows === 1) {
-      throw new RangeError('A matrix cannot have less than one row');
-    }
     this.data.splice(index, 1);
     this.rows -= 1;
     return this;
@@ -1490,7 +1534,7 @@ export default class Matrix extends AbstractMatrix {
       index = this.rows;
     }
     checkRowIndex(this, index, true);
-    array = Float64Array.from(checkRowVector(this, array, true));
+    array = Float64Array.from(checkRowVector(this, array));
     this.data.splice(index, 0, array);
     this.rows += 1;
     return this;
@@ -1498,9 +1542,6 @@ export default class Matrix extends AbstractMatrix {
 
   removeColumn(index) {
     checkColumnIndex(this, index);
-    if (this.columns === 1) {
-      throw new RangeError('A matrix cannot have less than one column');
-    }
     for (let i = 0; i < this.rows; i++) {
       const newRow = new Float64Array(this.columns - 1);
       for (let j = 0; j < index; j++) {

package/src/pseudoInverse.js

@@ -3,6 +3,12 @@ import Matrix from './matrix';
 
 export function pseudoInverse(matrix, threshold = Number.EPSILON) {
   matrix = Matrix.checkMatrix(matrix);
+  if (matrix.isEmpty()) {
+    // with a zero dimension, the pseudo-inverse is the transpose, since all 0xn and nx0 matrices are singular
+    // (0xn)*(nx0)*(0xn) = 0xn
+    // (nx0)*(0xn)*(nx0) = nx0
+    return matrix.transpose();
+  }
   let svdSolution = new SVD(matrix, { autoTranspose: true });
 
   let U = svdSolution.leftSingularVectors;

package/src/util.js

@@ -143,3 +143,9 @@ function checkNumber(name, value) {
     throw new TypeError(`${name} must be a number`);
   }
 }
+
+export function checkNonEmpty(matrix) {
+  if (matrix.isEmpty()) {
+    throw new Error('Empty matrix has no elements to index');
+  }
+}