@smockle/matrix 3.0.6 → 4.0.0

package/src/index.ts

@@ -0,0 +1,290 @@
+import { fill, flattenDeep, invert, padStart, unzip } from "lodash";
+import { inv } from "mathjs";
+
+type Matrix = {
+  __value: number | (number | number[])[];
+  countRows: () => number;
+  countColumns: () => number;
+  addable: (y: Matrix) => boolean;
+  add: (y: Matrix) => Matrix;
+  multipliable: (y: Matrix) => boolean;
+  multiply: (y: Matrix) => Matrix;
+  transpose: () => Matrix;
+  invert: () => Matrix;
+  map: (x: any) => Matrix;
+  valueOf: () => number | (number | number[])[];
+};
+
+/**
+ * Creates a Matrix
+ * @constructor
+ * @alias module:matrix
+ * @param {number|(number | number[])[]} x - Values to store in matrix
+ * @throws {TypeError} Argument x must be a number or number array
+ * @return {Matrix} Single or multi dimensional matrix
+ */
+function Matrix(x: number | (number | number[])[]): Matrix {
+  // extra nesting
+  if (Array.isArray(x) && Array.isArray(x[0]) && x.length === 1) {
+    throw new TypeError("Matrix must be a number or array of numbers");
+  }
+
+  // uneven rows
+  if (
+    Array.isArray(x) &&
+    Array.isArray(x[0]) &&
+    x.some(
+      (row) => Array.isArray(row) && row.length !== (x[0] as number[]).length
+    )
+  ) {
+    throw new TypeError("Matrix must be a number or array of numbers");
+  }
+
+  /* Single or multi dimensional matrix */
+  const matrix = Object.create(Matrix.prototype);
+  matrix.__value = x;
+  return matrix;
+}
+
+/**
+ * Determines whether two matrices can be summed
+ * @alias module:matrix.addable
+ * @param  {Matrix} x - Matrix to check
+ * @param  {Matrix} y - Matrix to check
+ * @return {boolean} Whether two matrices can be summed (using matrix addition)
+ */
+Matrix.addable = function (x: Matrix, y: Matrix): boolean {
+  return (
+    x.countRows() === y.countRows() && x.countColumns() === y.countColumns()
+  );
+};
+
+/**
+ * Adds two matrices using matrix addition
+ * @alias module:matrix.add
+ * @param {Matrix} x - Matrix to add
+ * @param {Matrix} y - Matrix to add
+ * @throws {TypeError} Matrices are not addable
+ * @return {Matrix} New matrix with the summation
+ */
+Matrix.add = function (x: Matrix, y: Matrix): Matrix {
+  if (!Matrix.addable(x, y)) throw new TypeError("Matrices are not addable");
+  return x.map((row: number[], i: number): number[] =>
+    row.map(
+      (column: number, j: number): number =>
+        column + (y.__value as number[][])[i][j]
+    )
+  );
+};
+
+/**
+ * Determines whether two matrices can be multiplied
+ * @alias module:matrix.multipliable
+ * @param  {Matrix} x - Matrix to check
+ * @param  {Matrix} y - Matrix to check
+ * @return {boolean} Whether two matrices can be summed (using matrix multiplication)
+ */
+Matrix.multipliable = function (x: Matrix, y: Matrix): boolean {
+  return x.countColumns() === y.countRows();
+};
+
+/**
+ * Calculates the inner product of two matrices
+ * @param  {Matrix} x - Matrix to multiply
+ * @param  {Matrix} y - Matrix to multiply
+ * @param  {number} i - Column in matrix y to multiply
+ * @return {number} Inner product of matrices
+ */
+function innerproduct(x: Matrix, y: Matrix, i: number): number {
+  const _x: number[] = x.__value as number[];
+  const _y: number[] =
+    Array.isArray(unzip<number>(y.__value as number[][])) &&
+    unzip<number>(y.__value as number[][]).length === 0
+      ? unzip([y.__value as number[]])[i]
+      : unzip(y.__value as number[][])[i];
+  return ([] as number[])
+    .concat(_x)
+    .reduce((z: number, _z: number, j: number): number => z + _z * _y[j], 0);
+}
+
+/**
+ * Calculates the dot product of two matrices
+ * @alias module:matrix.multiply
+ * @param  {Matrix} x - Matrix to multiply
+ * @param  {Matrix} y - Matrix to multiply
+ * @return {Matrix} New matrix with the dot product
+ */
+Matrix.multiply = function (x: Matrix, y: Matrix): Matrix {
+  if (!Matrix.multipliable(x, y)) {
+    throw new TypeError("Matrices are not multipliable");
+  }
+
+  if (x.countColumns() === 0 && y.countRows() === 0) {
+    return Matrix((x.__value as number) * (y.__value as number));
+  }
+
+  /* New matrix with the dot product */
+  const z: Matrix = Matrix(
+    fill(
+      Array(x.countRows()),
+      x.countRows() !== 1 ? fill(Array(y.countColumns()), 0) : 0
+    )
+  );
+  return z.map((_z: number | number[], i: number): number | number[] => {
+    if (typeof _z === "number") return innerproduct(x, y, i);
+    return _z.map((_, j) =>
+      innerproduct(Matrix((x.__value as number[])[i]), y, j)
+    );
+  });
+};
+
+/**
+ * Inverts a matrix
+ * @alias module:matrix.invert
+ * @param  {x} Matrix to invert
+ * @return {Matrix} Matrix inverse
+ */
+Matrix.invert = function (x: Matrix): Matrix {
+  return Matrix(inv<any>(x instanceof Matrix ? x.__value : x));
+};
+
+/**
+ * Counts rows in this matrix
+ * @alias module:matrix#countRows
+ * @return {number} Number of rows
+ */
+Matrix.prototype.countRows = function (this: Matrix): number {
+  if (typeof this.__value === "number") return 0;
+  if (typeof this.__value[0] === "number") return 1;
+  return this.__value.length;
+};
+
+/**
+ * Counts columns in this matrix
+ * @alias module:matrix#countColumns
+ * @return {number} Number of columns
+ */
+Matrix.prototype.countColumns = function (this: Matrix): number {
+  if (typeof this.__value === "number") return 0;
+  if (typeof this.__value[0] === "number") return this.__value.length;
+  return this.__value[0].length;
+};
+
+/**
+ * Determines whether this matrix can be summed
+ * @alias module:matrix#addable
+ * @param  {Matrix} y - Matrix to check
+ * @return {boolean} Whether this matrix can be summed (using matrix addition)
+ */
+Matrix.prototype.addable = function (this: Matrix, y: Matrix): boolean {
+  return Matrix.addable(this, y);
+};
+
+/**
+ * Adds this matrix using matrix addition
+ * @alias module:matrix#add
+ * @param {Matrix} y - Matrix to add
+ * @return {Matrix} New matrix with the summation
+ */
+Matrix.prototype.add = function (this: Matrix, y: Matrix): Matrix {
+  return Matrix.add(this, y);
+};
+
+/**
+ * Determines whether this matrix can be multiplied
+ * @alias module:matrix#multipliable
+ * @param  {Matrix} y - Matrix to check
+ * @return {boolean} Whether two matrices can be summed (using matrix multiplication)
+ */
+Matrix.prototype.multipliable = function (this: Matrix, y: Matrix): boolean {
+  return Matrix.multipliable(this, y);
+};
+
+/**
+ * Calculates the dot product of this matrix
+ * @alias module:matrix#multiply
+ * @param  {Matrix} y - Matrix to multiply
+ * @return {Matrix} New matrix with the dot product
+ */
+Matrix.prototype.multiply = function (this: Matrix, y: Matrix): Matrix {
+  return Matrix.multiply(this, y);
+};
+
+/**
+ * Calculates the transpose of this matrix
+ * @alias module:matrix#transpose
+ * @return {Matrix} New matrix with the transpose
+ */
+Matrix.prototype.transpose = function (this: Matrix): Matrix {
+  switch (this.countRows()) {
+    case 0:
+      return Matrix(this.__value as number);
+    case 1:
+      return Matrix(unzip([this.__value as number[]]));
+    default:
+      return Matrix(unzip(this.__value as number[][]));
+  }
+};
+
+/**
+ * Inverts this matrix
+ * @alias module:matrix#invert
+ * @return {Matrix} Matrix inverse
+ */
+Matrix.prototype.invert = function (this: Matrix): Matrix {
+  return Matrix.invert(this);
+};
+
+/**
+ * Maps over this matrix
+ * @alias module:matrix#map
+ * @return {Matrix} Matrix inverse
+ */
+Matrix.prototype.map = function (this: Matrix, x: any): Matrix {
+  if (typeof this.__value === "number") return Matrix(x(this.__value));
+  return Matrix(this.__value.map(x));
+};
+
+/**
+ * Returns the number or number array value
+ * @alias module:matrix#valueOf
+ * @return {number|number[]} Number of number array value
+ */
+Matrix.prototype.valueOf = function (
+  this: Matrix
+): number | (number | number[])[] {
+  return this.__value;
+};
+
+/**
+ * Formats and prints the matrix value
+ * @alias module:matrix#inspect
+ * @return {string} Formatted matrix value
+ */
+Matrix.prototype[Symbol.for("nodejs.util.inspect.custom")] = function (
+  this: Matrix
+): string {
+  switch (this.countRows()) {
+    case 0:
+      return `${this.__value}`;
+    case 1:
+      return `[ ${(this.__value as number[]).join(" ")} ]`;
+    default:
+      /* Output array filled with zeroes */
+      const padding: number[] = unzip(this.__value as number[][]).map(
+        (column: number[]) =>
+          column.reduce((length, x) => Math.max(`${x}`.length, length), 0)
+      );
+      return (this.__value as number[][])
+        .reduce(
+          (output, row) =>
+            `${output}[ ${row
+              .map((x, i) => padStart(`${x}`, padding[i]))
+              .join(" ")} ]`,
+          ""
+        )
+        .replace(/]\[/g, "]\n[");
+  }
+};
+
+export default Matrix;

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true,
+    "strict": true,
+    "rootDir": "src",
+    "outDir": "dist",
+    "composite": true,
+    "incremental": true
+  },
+  "include": ["src/**/*.ts"],
+  "ts-node": {
+    "esm": true
+  }
+}

package/.editorconfig

@@ -1,7 +0,0 @@
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-end_of_line = lf
-insert_final_newline = true

package/.eslintignore

@@ -1 +0,0 @@
-flow-typed/*

package/.eslintrc.json

@@ -1,6 +0,0 @@
-{
-  "extends": "standard",
-  "rules": {
-    "no-global-assign": ["error", { "exceptions": ["require"] }]
-  }
-}

package/.flowconfig

@@ -1,27 +0,0 @@
-[ignore]
-
-[include]
-
-[libs]
-
-[options]
-# Run Flow on .js, .mjs, .jsx, .json files
-module.file_ext=.js
-module.file_ext=.mjs
-module.file_ext=.jsx
-module.file_ext=.json
-
-# Use the Node.js module system to resolve `import` and `require`
-module.system=node
-
-# Allow static class fields
-esproposal.class_static_fields=enable
-
-# Allow instance class fields
-esproposal.class_instance_fields=enable
-
-# Treat underscore-prefixed class properties and methods as private
-munge_underscores=true
-
-# Ignore next line with /* @flow disable */ magic comment
-suppress_comment= \\(.\\|\n\\)*\\@flow disable

package/.prettierignore

@@ -1 +0,0 @@
-package.json

package/.travis.yml

@@ -1,19 +0,0 @@
-language: node_js
-node_js:
-- '8'
-- '6'
-notifications:
-  email:
-    on_success: change
-    on_failure: always
-before_install:
-- npm install -g greenkeeper-lockfile@1
-before_script:
-- greenkeeper-lockfile-update
-after_script:
-- greenkeeper-lockfile-upload
-- npm run coverage
-- codecov
-env:
-  global:
-  - secure: NWsEQyPx6mgrl+Q6k9iYd8V+xUSuzYJLi5nN8K3YNjx5/lzxNliCY89dGQ/sUZy3I2dtiQb61Cno6Ki7de2Q2yWSCZJK7w1x0B8zk2tb1J/Gyy4G4HFhjeWPyJQ61BiH+vu3zpA+Ad+/faR/pBegPd43gQ7qGbOldj2jikQ4T3qo+0c0yAcu0lveEmgB6CrvFf/TojI2BTPD9ez8rlJlTVUMhqm8j0Kly48mdchx08E8BTTHDx0I9UceuTxuy8HyKbL0wOARf6tsTiBVbKdie/qDwu3NUP0mGJ7Xt0C9/YLfuhP7e+cORzT+JWQuRREZys/x+xX43ckDS5HLq09Aeodc85toSD3CIWjNNE9hKr91EjmysIqvzFmZ0ElyDXjHKLrmfcedI2TAajuY0pycDD6zC/eddDIl8jhsbYKEZfArO763aM5hXHdxviJpmsdIBU2A297MrG4LzRZW6kUkO8rUaXqBzNiafICrOskF6hE91qIiJGd8an4i7zeBfnb3q1S4BVBzBj7DiH6p+Ud5PJkASOhj/7O5Qamg6LSDaEkzaYN4QL+z8rvCVthaWtJFpxVAa8RL7xrfMY9nwtPClbgwz28RS7dHrqZiDZA8a6UPbkGLLo9w2Gmlti0I5XJtc5gkWOQU9pVKYwXpEKi0rWNtFTbAmh++NSn+Givtsrs=

package/appveyor.yml

@@ -1,21 +0,0 @@
-# scripts that are called at very beginning, before repo cloning
-init:
-  - git config --global core.autocrlf input
-
-# scripts that run after cloning repository
-install:
-  # Install node 8
-  - ps: Install-Product node 8
-  # install modules
-  - npm install
-
-# to run your custom scripts instead of automatic tests
-test_script:
-  # Output useful info for debugging.
-  - node --version
-  - npm --version
-  # run tests
-  - npm test
-
-# Don't build with msbuild.
-build: off

package/flow-typed/npm/@std/esm_vx.x.x.js

@@ -1,33 +0,0 @@
-// flow-typed signature: 1a1a5f7378a3eb94c91b140831760eab
-// flow-typed version: <<STUB>>/@std/esm_v^0.5.1/flow_v0.53.1
-
-/**
- * This is an autogenerated libdef stub for:
- *
- *   '@std/esm'
- *
- * Fill this stub out by replacing all the `any` types.
- *
- * Once filled out, we encourage you to share your work with the
- * community by sending a pull request to:
- * https://github.com/flowtype/flow-typed
- */
-
-declare module '@std/esm' {
-  declare module.exports: any;
-}
-
-/**
- * We include stubs for each file inside this npm package in case you need to
- * require those files directly. Feel free to delete any files that aren't
- * needed.
- */
-
-
-// Filename aliases
-declare module '@std/esm/index' {
-  declare module.exports: $Exports<'@std/esm'>;
-}
-declare module '@std/esm/index.js' {
-  declare module.exports: $Exports<'@std/esm'>;
-}