mathjs 7.2.0 → 7.5.1

package/src/expression/embeddedDocs/embeddedDocs.js

@@ -9,6 +9,9 @@ import { isNegativeDocs } from './function/utils/isNegative'
 import { isIntegerDocs } from './function/utils/isInteger'
 import { isNaNDocs } from './function/utils/isNaN'
 import { formatDocs } from './function/utils/format'
+import { binDocs } from './function/utils/bin'
+import { octDocs } from './function/utils/oct'
+import { hexDocs } from './function/utils/hex'
 import { cloneDocs } from './function/utils/clone'
 import { toDocs } from './function/units/to'
 import { tanhDocs } from './function/trigonometry/tanh'
@@ -167,11 +170,13 @@ import { addDocs } from './function/arithmetic/add'
 import { absDocs } from './function/arithmetic/abs'
 import { qrDocs } from './function/algebra/qr'
 import { usolveDocs } from './function/algebra/usolve'
+import { usolveAllDocs } from './function/algebra/usolveAll'
 import { sluDocs } from './function/algebra/slu'
 import { rationalizeDocs } from './function/algebra/rationalize'
 import { simplifyDocs } from './function/algebra/simplify'
 import { lupDocs } from './function/algebra/lup'
 import { lsolveDocs } from './function/algebra/lsolve'
+import { lsolveAllDocs } from './function/algebra/lsolveAll'
 import { derivativeDocs } from './function/algebra/derivative'
 import { versionDocs } from './constants/version'
 import { trueDocs } from './constants/true'
@@ -209,6 +214,7 @@ import { sinDocs } from './function/trigonometry/sin'
 import { numericDocs } from './function/utils/numeric'
 import { columnDocs } from './function/matrix/column'
 import { rowDocs } from './function/matrix/row'
+import { rotationMatrixDocs } from './function/matrix/rotationMatrix'
 
 export const embeddedDocs = {
 
@@ -310,12 +316,14 @@ export const embeddedDocs = {
   // functions - algebra
   derivative: derivativeDocs,
   lsolve: lsolveDocs,
+  lsolveAll: lsolveAllDocs,
   lup: lupDocs,
   lusolve: lusolveDocs,
   simplify: simplifyDocs,
   rationalize: rationalizeDocs,
   slu: sluDocs,
   usolve: usolveDocs,
+  usolveAll: usolveAllDocs,
   qr: qrDocs,
 
   // functions - arithmetic
@@ -419,6 +427,7 @@ export const embeddedDocs = {
   range: rangeDocs,
   resize: resizeDocs,
   reshape: reshapeDocs,
+  rotationMatrix: rotationMatrixDocs,
   row: rowDocs,
   size: sizeDocs,
   sort: sortDocs,
@@ -515,6 +524,9 @@ export const embeddedDocs = {
   // functions - utils
   clone: cloneDocs,
   format: formatDocs,
+  bin: binDocs,
+  oct: octDocs,
+  hex: hexDocs,
   isNaN: isNaNDocs,
   isInteger: isIntegerDocs,
   isNegative: isNegativeDocs,

package/src/expression/embeddedDocs/function/algebra/lsolve.js

@@ -5,13 +5,13 @@ export const lsolveDocs = {
     'x=lsolve(L, b)'
   ],
   description:
-  'Solves the linear system L * x = b where L is an [n x n] lower triangular matrix and b is a [n] column vector.',
+  'Finds one solution of the linear system L * x = b where L is an [n x n] lower triangular matrix and b is a [n] column vector.',
   examples: [
     'a = [-2, 3; 2, 1]',
     'b = [11, 9]',
     'x = lsolve(a, b)'
   ],
   seealso: [
-    'lup', 'lusolve', 'usolve', 'matrix', 'sparse'
+    'lsolveAll', 'lup', 'lusolve', 'usolve', 'matrix', 'sparse'
   ]
 }

package/src/expression/embeddedDocs/function/algebra/lsolveAll.js

@@ -0,0 +1,17 @@
+export const lsolveAllDocs = {
+  name: 'lsolveAll',
+  category: 'Algebra',
+  syntax: [
+    'x=lsolveAll(L, b)'
+  ],
+  description:
+  'Finds all solutions of the linear system L * x = b where L is an [n x n] lower triangular matrix and b is a [n] column vector.',
+  examples: [
+    'a = [-2, 3; 2, 1]',
+    'b = [11, 9]',
+    'x = lsolve(a, b)'
+  ],
+  seealso: [
+    'lsolve', 'lup', 'lusolve', 'usolve', 'matrix', 'sparse'
+  ]
+}

package/src/expression/embeddedDocs/function/algebra/usolve.js

@@ -5,11 +5,11 @@ export const usolveDocs = {
     'x=usolve(U, b)'
   ],
   description:
-  'Solves the linear system U * x = b where U is an [n x n] upper triangular matrix and b is a [n] column vector.',
+  'Finds one solution of the linear system U * x = b where U is an [n x n] upper triangular matrix and b is a [n] column vector.',
   examples: [
     'x=usolve(sparse([1, 1, 1, 1; 0, 1, 1, 1; 0, 0, 1, 1; 0, 0, 0, 1]), [1; 2; 3; 4])'
   ],
   seealso: [
-    'lup', 'lusolve', 'lsolve', 'matrix', 'sparse'
+    'usolveAll', 'lup', 'lusolve', 'lsolve', 'matrix', 'sparse'
   ]
 }

package/src/expression/embeddedDocs/function/algebra/usolveAll.js

@@ -0,0 +1,15 @@
+export const usolveAllDocs = {
+  name: 'usolveAll',
+  category: 'Algebra',
+  syntax: [
+    'x=usolve(U, b)'
+  ],
+  description:
+  'Finds all solutions of the linear system U * x = b where U is an [n x n] upper triangular matrix and b is a [n] column vector.',
+  examples: [
+    'x=usolve(sparse([1, 1, 1, 1; 0, 1, 1, 1; 0, 0, 1, 1; 0, 0, 0, 1]), [1; 2; 3; 4])'
+  ],
+  seealso: [
+    'usolve', 'lup', 'lusolve', 'lsolve', 'matrix', 'sparse'
+  ]
+}

package/src/expression/embeddedDocs/function/matrix/rotationMatrix.js

@@ -0,0 +1,19 @@
+export const rotationMatrixDocs = {
+  name: 'rotationMatrix',
+  category: 'Matrix',
+  syntax: [
+    'rotationMatrix(theta)',
+    'rotationMatrix(theta, v)',
+    'rotationMatrix(theta, v, format)'
+  ],
+  description: 'Returns a 2-D rotation matrix (2x2) for a given angle (in radians). ' +
+    'Returns a 2-D rotation matrix (3x3) of a given angle (in radians) around given axis.',
+  examples: [
+    'rotationMatrix(pi / 2)',
+    'rotationMatrix(unit("45deg"), [0, 0, 1])',
+    'rotationMatrix(1, matrix([0, 0, 1]), "sparse")'
+  ],
+  seealso: [
+    'cos', 'sin'
+  ]
+}

package/src/expression/embeddedDocs/function/utils/bin.js

@@ -0,0 +1,12 @@
+export const binDocs = {
+  name: 'bin',
+  category: 'Utils',
+  syntax: [
+    'bin(value)'
+  ],
+  description: 'Format a number as binary',
+  examples: [
+    'bin(2)'
+  ],
+  seealso: ['oct', 'hex']
+}

package/src/expression/embeddedDocs/function/utils/hex.js

@@ -0,0 +1,12 @@
+export const hexDocs = {
+  name: 'hex',
+  category: 'Utils',
+  syntax: [
+    'hex(value)'
+  ],
+  description: 'Format a number as hexadecimal',
+  examples: [
+    'hex(240)'
+  ],
+  seealso: ['bin', 'oct']
+}

package/src/expression/embeddedDocs/function/utils/oct.js

@@ -0,0 +1,12 @@
+export const octDocs = {
+  name: 'oct',
+  category: 'Utils',
+  syntax: [
+    'oct(value)'
+  ],
+  description: 'Format a number as octal',
+  examples: [
+    'oct(56)'
+  ],
+  seealso: ['bin', 'hex']
+}

package/src/expression/parse.js

@@ -321,6 +321,20 @@ export const createParse = /* #__PURE__ */ factory(name, dependencies, ({
     if (parse.isDigitDot(c1)) {
       state.tokenType = TOKENTYPE.NUMBER
 
+      // check for binary, octal, or hex
+      const c2 = currentString(state, 2)
+      if (c2 === '0b' || c2 === '0o' || c2 === '0x') {
+        state.token += currentCharacter(state)
+        next(state)
+        state.token += currentCharacter(state)
+        next(state)
+        while (parse.isHexDigit(currentCharacter(state))) {
+          state.token += currentCharacter(state)
+          next(state)
+        }
+        return
+      }
+
       // get number, can have a single dot
       if (currentCharacter(state) === '.') {
         state.token += currentCharacter(state)
@@ -522,6 +536,17 @@ export const createParse = /* #__PURE__ */ factory(name, dependencies, ({
     return (c >= '0' && c <= '9')
   }
 
+  /**
+   * checks if the given char c is a hex digit
+   * @param {string} c   a string with one character
+   * @return {boolean}
+   */
+  parse.isHexDigit = function isHexDigit (c) {
+    return ((c >= '0' && c <= '9') ||
+            (c >= 'a' && c <= 'f') ||
+            (c >= 'A' && c <= 'F'))
+  }
+
   /**
    * Start of the parse levels below, in order of precedence
    * @return {Node} node

package/src/factoriesAny.js

@@ -78,6 +78,7 @@ export { createOnes } from './function/matrix/ones'
 export { createRange } from './function/matrix/range'
 export { createReshape } from './function/matrix/reshape'
 export { createResize } from './function/matrix/resize'
+export { createRotationMatrix } from './function/matrix/rotationMatrix'
 export { createRow } from './function/matrix/row'
 export { createSize } from './function/matrix/size'
 export { createSqueeze } from './function/matrix/squeeze'
@@ -89,6 +90,9 @@ export { createErf } from './function/special/erf'
 export { createMode } from './function/statistics/mode'
 export { createProd } from './function/statistics/prod'
 export { createFormat } from './function/string/format'
+export { createBin } from './function/string/bin'
+export { createOct } from './function/string/oct'
+export { createHex } from './function/string/hex'
 export { createPrint } from './function/string/print'
 export { createTo } from './function/unit/to'
 export { createIsPrime } from './function/utils/isPrime'
@@ -103,6 +107,8 @@ export { createDotPow } from './function/arithmetic/dotPow'
 export { createDotDivide } from './function/arithmetic/dotDivide'
 export { createLsolve } from './function/algebra/solver/lsolve'
 export { createUsolve } from './function/algebra/solver/usolve'
+export { createLsolveAll } from './function/algebra/solver/lsolveAll'
+export { createUsolveAll } from './function/algebra/solver/usolveAll'
 export { createLeftShift } from './function/bitwise/leftShift'
 export { createRightArithShift } from './function/bitwise/rightArithShift'
 export { createRightLogShift } from './function/bitwise/rightLogShift'

package/src/function/algebra/solver/lsolve.js

@@ -16,7 +16,7 @@ export const createLsolve = /* #__PURE__ */ factory(name, dependencies, ({ typed
   const solveValidation = createSolveValidation({ DenseMatrix })
 
   /**
-   * Solves the linear equation system by forwards substitution. Matrix must be a lower triangular matrix.
+   * Finds one solution of a linear equation system by forwards substitution. Matrix must be a lower triangular matrix. Throws an error if there's no solution.
    *
    * `L * x = b`
    *
@@ -32,7 +32,7 @@ export const createLsolve = /* #__PURE__ */ factory(name, dependencies, ({ typed
    *
    * See also:
    *
-   *    lup, slu, usolve, lusolve
+   *    lsolveAll, lup, slu, usolve, lusolve
    *
    * @param {Matrix, Array} L       A N x N matrix or array (L)
    * @param {Matrix, Array} b       A column vector with the b values
@@ -42,21 +42,16 @@ export const createLsolve = /* #__PURE__ */ factory(name, dependencies, ({ typed
   return typed(name, {
 
     'SparseMatrix, Array | Matrix': function (m, b) {
-      // process matrix
       return _sparseForwardSubstitution(m, b)
     },
 
     'DenseMatrix, Array | Matrix': function (m, b) {
-      // process matrix
       return _denseForwardSubstitution(m, b)
     },
 
     'Array, Array | Matrix': function (a, b) {
-      // create dense matrix from array
       const m = matrix(a)
-      // use matrix implementation
       const r = _denseForwardSubstitution(m, b)
-      // result
       return r.valueOf()
     }
   })
@@ -64,45 +59,44 @@ export const createLsolve = /* #__PURE__ */ factory(name, dependencies, ({ typed
   function _denseForwardSubstitution (m, b) {
     // validate matrix and vector, return copy of column vector b
     b = solveValidation(m, b, true)
-    // column vector data
     const bdata = b._data
-    // rows & columns
+
     const rows = m._size[0]
     const columns = m._size[1]
+
     // result
     const x = []
-    // data
-    const data = m._data
-    // forward solve m * x = b, loop columns
+
+    const mdata = m._data
+
+    // loop columns
     for (let j = 0; j < columns; j++) {
-      // b[j]
       const bj = bdata[j][0] || 0
-      // x[j]
       let xj
-      // forward substitution (outer product) avoids inner looping when bj === 0
+
       if (!equalScalar(bj, 0)) {
-        // value @ [j, j]
-        const vjj = data[j][j]
-        // check vjj
+        // non-degenerate row, find solution
+
+        const vjj = mdata[j][j]
+
         if (equalScalar(vjj, 0)) {
-          // system cannot be solved
           throw new Error('Linear system cannot be solved since matrix is singular')
         }
-        // calculate xj
+
         xj = divideScalar(bj, vjj)
+
         // loop rows
         for (let i = j + 1; i < rows; i++) {
-          // update copy of b
-          bdata[i] = [subtract(bdata[i][0] || 0, multiplyScalar(xj, data[i][j]))]
+          bdata[i] = [subtract(bdata[i][0] || 0, multiplyScalar(xj, mdata[i][j]))]
         }
       } else {
-        // zero @ j
+        // degenerate row, we can choose any value
         xj = 0
       }
-      // update x
+
       x[j] = [xj]
     }
-    // return vector
+
     return new DenseMatrix({
       data: x,
       size: [rows, 1]
@@ -112,68 +106,68 @@ export const createLsolve = /* #__PURE__ */ factory(name, dependencies, ({ typed
   function _sparseForwardSubstitution (m, b) {
     // validate matrix and vector, return copy of column vector b
     b = solveValidation(m, b, true)
-    // column vector data
+
     const bdata = b._data
-    // rows & columns
+
     const rows = m._size[0]
     const columns = m._size[1]
-    // matrix arrays
+
     const values = m._values
     const index = m._index
     const ptr = m._ptr
-    // vars
-    let i, k
+
     // result
     const x = []
-    // forward solve m * x = b, loop columns
+
+    // loop columns
     for (let j = 0; j < columns; j++) {
-      // b[j]
       const bj = bdata[j][0] || 0
-      // forward substitution (outer product) avoids inner looping when bj === 0
+
       if (!equalScalar(bj, 0)) {
-        // value @ [j, j]
+        // non-degenerate row, find solution
+
         let vjj = 0
-        // lower triangular matrix values & index (column j)
-        const jvalues = []
-        const jindex = []
-        // last index in column
-        let l = ptr[j + 1]
-        // values in column, find value @ [j, j]
-        for (k = ptr[j]; k < l; k++) {
-          // row
-          i = index[k]
+        // matrix values & indices (column j)
+        const jValues = []
+        const jIndices = []
+
+        // first and last index in the column
+        const firstIndex = ptr[j]
+        const lastIndex = ptr[j + 1]
+
+        // values in column, find value at [j, j]
+        for (let k = firstIndex; k < lastIndex; k++) {
+          const i = index[k]
+
           // check row (rows are not sorted!)
           if (i === j) {
-            // update vjj
             vjj = values[k]
           } else if (i > j) {
             // store lower triangular
-            jvalues.push(values[k])
-            jindex.push(i)
+            jValues.push(values[k])
+            jIndices.push(i)
           }
         }
-        // at this point we must have a value @ [j, j]
+
+        // at this point we must have a value in vjj
         if (equalScalar(vjj, 0)) {
-          // system cannot be solved, there is no value @ [j, j]
           throw new Error('Linear system cannot be solved since matrix is singular')
         }
-        // calculate xj
+
         const xj = divideScalar(bj, vjj)
-        // loop lower triangular
-        for (k = 0, l = jindex.length; k < l; k++) {
-          // row
-          i = jindex[k]
-          // update copy of b
-          bdata[i] = [subtract(bdata[i][0] || 0, multiplyScalar(xj, jvalues[k]))]
+
+        for (let k = 0, l = jIndices.length; k < l; k++) {
+          const i = jIndices[k]
+          bdata[i] = [subtract(bdata[i][0] || 0, multiplyScalar(xj, jValues[k]))]
         }
-        // update x
+
         x[j] = [xj]
       } else {
-        // update x
+        // degenerate row, we can choose any value
         x[j] = [0]
       }
     }
-    // return vector
+
     return new DenseMatrix({
       data: x,
       size: [rows, 1]

package/src/function/algebra/solver/lsolveAll.js

@@ -0,0 +1,197 @@
+import { factory } from '../../../utils/factory'
+import { createSolveValidation } from './utils/solveValidation'
+
+const name = 'lsolveAll'
+const dependencies = [
+  'typed',
+  'matrix',
+  'divideScalar',
+  'multiplyScalar',
+  'subtract',
+  'equalScalar',
+  'DenseMatrix'
+]
+
+export const createLsolveAll = /* #__PURE__ */ factory(name, dependencies, ({ typed, matrix, divideScalar, multiplyScalar, subtract, equalScalar, DenseMatrix }) => {
+  const solveValidation = createSolveValidation({ DenseMatrix })
+
+  /**
+   * Finds all solutions of a linear equation system by forwards substitution. Matrix must be a lower triangular matrix.
+   *
+   * `L * x = b`
+   *
+   * Syntax:
+   *
+   *    math.lsolve(L, b)
+   *
+   * Examples:
+   *
+   *    const a = [[-2, 3], [2, 1]]
+   *    const b = [11, 9]
+   *    const x = lsolve(a, b)  // [ [[-5.5], [20]] ]
+   *
+   * See also:
+   *
+   *    lsolve, lup, slu, usolve, lusolve
+   *
+   * @param {Matrix, Array} L       A N x N matrix or array (L)
+   * @param {Matrix, Array} b       A column vector with the b values
+   *
+   * @return {DenseMatrix[] | Array[]}  An array of affine-independent column vectors (x) that solve the linear system
+   */
+  return typed(name, {
+
+    'SparseMatrix, Array | Matrix': function (m, b) {
+      return _sparseForwardSubstitution(m, b)
+    },
+
+    'DenseMatrix, Array | Matrix': function (m, b) {
+      return _denseForwardSubstitution(m, b)
+    },
+
+    'Array, Array | Matrix': function (a, b) {
+      const m = matrix(a)
+      const R = _denseForwardSubstitution(m, b)
+      return R.map(r => r.valueOf())
+    }
+  })
+
+  function _denseForwardSubstitution (m, b_) {
+    // the algorithm is derived from
+    // https://www.overleaf.com/project/5e6c87c554a3190001a3fc93
+
+    // array of right-hand sides
+    const B = [solveValidation(m, b_, true)._data.map(e => e[0])]
+
+    const M = m._data
+    const rows = m._size[0]
+    const columns = m._size[1]
+
+    // loop columns
+    for (let i = 0; i < columns; i++) {
+      let L = B.length
+
+      // loop right-hand sides
+      for (let k = 0; k < L; k++) {
+        const b = B[k]
+
+        if (!equalScalar(M[i][i], 0)) {
+          // non-singular row
+
+          b[i] = divideScalar(b[i], M[i][i])
+
+          for (let j = i + 1; j < columns; j++) {
+            // b[j] -= b[i] * M[j,i]
+            b[j] = subtract(b[j], multiplyScalar(b[i], M[j][i]))
+          }
+        } else if (!equalScalar(b[i], 0)) {
+          // singular row, nonzero RHS
+
+          if (k === 0) {
+            // There is no valid solution
+            return []
+          } else {
+            // This RHS is invalid but other solutions may still exist
+            B.splice(k, 1)
+            k -= 1
+            L -= 1
+          }
+        } else if (k === 0) {
+          // singular row, RHS is zero
+
+          const bNew = [...b]
+          bNew[i] = 1
+
+          for (let j = i + 1; j < columns; j++) {
+            bNew[j] = subtract(bNew[j], M[j][i])
+          }
+
+          B.push(bNew)
+        }
+      }
+    }
+
+    return B.map(x => new DenseMatrix({ data: x.map(e => [e]), size: [rows, 1] }))
+  }
+
+  function _sparseForwardSubstitution (m, b_) {
+    // array of right-hand sides
+    const B = [solveValidation(m, b_, true)._data.map(e => e[0])]
+
+    const rows = m._size[0]
+    const columns = m._size[1]
+
+    const values = m._values
+    const index = m._index
+    const ptr = m._ptr
+
+    // loop columns
+    for (let i = 0; i < columns; i++) {
+      let L = B.length
+
+      // loop right-hand sides
+      for (let k = 0; k < L; k++) {
+        const b = B[k]
+
+        // values & indices (column i)
+        const iValues = []
+        const iIndices = []
+
+        // first & last indeces in column
+        const firstIndex = ptr[i]
+        const lastIndex = ptr[i + 1]
+
+        // find the value at [i, i]
+        let Mii = 0
+        for (let j = firstIndex; j < lastIndex; j++) {
+          const J = index[j]
+          // check row
+          if (J === i) {
+            Mii = values[j]
+          } else if (J > i) {
+            // store lower triangular
+            iValues.push(values[j])
+            iIndices.push(J)
+          }
+        }
+
+        if (!equalScalar(Mii, 0)) {
+          // non-singular row
+
+          b[i] = divideScalar(b[i], Mii)
+
+          for (let j = 0, lastIndex = iIndices.length; j < lastIndex; j++) {
+            const J = iIndices[j]
+            b[J] = subtract(b[J], multiplyScalar(b[i], iValues[j]))
+          }
+        } else if (!equalScalar(b[i], 0)) {
+          // singular row, nonzero RHS
+
+          if (k === 0) {
+            // There is no valid solution
+            return []
+          } else {
+            // This RHS is invalid but other solutions may still exist
+            B.splice(k, 1)
+            k -= 1
+            L -= 1
+          }
+        } else if (k === 0) {
+          // singular row, RHS is zero
+
+          const bNew = [...b]
+          bNew[i] = 1
+
+          for (let j = 0, lastIndex = iIndices.length; j < lastIndex; j++) {
+            const J = iIndices[j]
+            bNew[J] = subtract(bNew[J], iValues[j])
+          }
+
+          B.push(bNew)
+        }
+      }
+    }
+
+    return B.map(x => new DenseMatrix({ data: x.map(e => [e]), size: [rows, 1] }))
+  }
+})