@smockle/matrix 3.0.5 → 4.0.0

package/flow-typed/npm/nyc_vx.x.x.js

@@ -1,108 +0,0 @@
-// flow-typed signature: f6e603c55941b36c9d8577c99c4196b5
-// flow-typed version: <<STUB>>/nyc_v^11.0.2/flow_v0.53.1
-
-/**
- * This is an autogenerated libdef stub for:
- *
- *   'nyc'
- *
- * 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 'nyc' {
-  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.
- */
-declare module 'nyc/bin/nyc' {
-  declare module.exports: any;
-}
-
-declare module 'nyc/bin/wrap' {
-  declare module.exports: any;
-}
-
-declare module 'nyc/lib/commands/instrument' {
-  declare module.exports: any;
-}
-
-declare module 'nyc/lib/config-util' {
-  declare module.exports: any;
-}
-
-declare module 'nyc/lib/hash' {
-  declare module.exports: any;
-}
-
-declare module 'nyc/lib/instrumenters/istanbul' {
-  declare module.exports: any;
-}
-
-declare module 'nyc/lib/instrumenters/noop' {
-  declare module.exports: any;
-}
-
-declare module 'nyc/lib/process-args' {
-  declare module.exports: any;
-}
-
-declare module 'nyc/lib/process' {
-  declare module.exports: any;
-}
-
-declare module 'nyc/lib/self-coverage-helper' {
-  declare module.exports: any;
-}
-
-declare module 'nyc/lib/source-maps' {
-  declare module.exports: any;
-}
-
-// Filename aliases
-declare module 'nyc/bin/nyc.js' {
-  declare module.exports: $Exports<'nyc/bin/nyc'>;
-}
-declare module 'nyc/bin/wrap.js' {
-  declare module.exports: $Exports<'nyc/bin/wrap'>;
-}
-declare module 'nyc/index' {
-  declare module.exports: $Exports<'nyc'>;
-}
-declare module 'nyc/index.js' {
-  declare module.exports: $Exports<'nyc'>;
-}
-declare module 'nyc/lib/commands/instrument.js' {
-  declare module.exports: $Exports<'nyc/lib/commands/instrument'>;
-}
-declare module 'nyc/lib/config-util.js' {
-  declare module.exports: $Exports<'nyc/lib/config-util'>;
-}
-declare module 'nyc/lib/hash.js' {
-  declare module.exports: $Exports<'nyc/lib/hash'>;
-}
-declare module 'nyc/lib/instrumenters/istanbul.js' {
-  declare module.exports: $Exports<'nyc/lib/instrumenters/istanbul'>;
-}
-declare module 'nyc/lib/instrumenters/noop.js' {
-  declare module.exports: $Exports<'nyc/lib/instrumenters/noop'>;
-}
-declare module 'nyc/lib/process-args.js' {
-  declare module.exports: $Exports<'nyc/lib/process-args'>;
-}
-declare module 'nyc/lib/process.js' {
-  declare module.exports: $Exports<'nyc/lib/process'>;
-}
-declare module 'nyc/lib/self-coverage-helper.js' {
-  declare module.exports: $Exports<'nyc/lib/self-coverage-helper'>;
-}
-declare module 'nyc/lib/source-maps.js' {
-  declare module.exports: $Exports<'nyc/lib/source-maps'>;
-}

package/flow-typed/npm/prettier-eslint-cli_vx.x.x.js

@@ -1,74 +0,0 @@
-// flow-typed signature: 56ebe15a26b55410ff353983dbf8c878
-// flow-typed version: <<STUB>>/prettier-eslint-cli_v^4.0.0/flow_v0.53.1
-
-/**
- * This is an autogenerated libdef stub for:
- *
- *   'prettier-eslint-cli'
- *
- * 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 'prettier-eslint-cli' {
-  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.
- */
-declare module 'prettier-eslint-cli/dist/add-exception-handler' {
-  declare module.exports: any;
-}
-
-declare module 'prettier-eslint-cli/dist/format-files' {
-  declare module.exports: any;
-}
-
-declare module 'prettier-eslint-cli/dist/index' {
-  declare module.exports: any;
-}
-
-declare module 'prettier-eslint-cli/dist/messages' {
-  declare module.exports: any;
-}
-
-declare module 'prettier-eslint-cli/dist/no-main' {
-  declare module.exports: any;
-}
-
-declare module 'prettier-eslint-cli/dist/parser' {
-  declare module.exports: any;
-}
-
-declare module 'prettier-eslint-cli/dist/uncaught-exception-handler' {
-  declare module.exports: any;
-}
-
-// Filename aliases
-declare module 'prettier-eslint-cli/dist/add-exception-handler.js' {
-  declare module.exports: $Exports<'prettier-eslint-cli/dist/add-exception-handler'>;
-}
-declare module 'prettier-eslint-cli/dist/format-files.js' {
-  declare module.exports: $Exports<'prettier-eslint-cli/dist/format-files'>;
-}
-declare module 'prettier-eslint-cli/dist/index.js' {
-  declare module.exports: $Exports<'prettier-eslint-cli/dist/index'>;
-}
-declare module 'prettier-eslint-cli/dist/messages.js' {
-  declare module.exports: $Exports<'prettier-eslint-cli/dist/messages'>;
-}
-declare module 'prettier-eslint-cli/dist/no-main.js' {
-  declare module.exports: $Exports<'prettier-eslint-cli/dist/no-main'>;
-}
-declare module 'prettier-eslint-cli/dist/parser.js' {
-  declare module.exports: $Exports<'prettier-eslint-cli/dist/parser'>;
-}
-declare module 'prettier-eslint-cli/dist/uncaught-exception-handler.js' {
-  declare module.exports: $Exports<'prettier-eslint-cli/dist/uncaught-exception-handler'>;
-}

package/jsdoc.json

@@ -1,6 +0,0 @@
-{
-  "source": {
-    "includePattern": ".+\\.(m)?js(doc|x)?$",
-    "excludePattern": "(^|\\/|\\\\)_"
-  }
-}

package/jsdoc2md/README.hbs

@@ -1,41 +0,0 @@
-[![npm](https://img.shields.io/npm/v/@smockle/matrix.svg)](https://www.npmjs.com/package/@smockle/matrix)
-[![Build Status](https://travis-ci.org/smockle/matrix.svg?branch=master)](https://travis-ci.org/smockle/matrix)
-[![Build status](https://ci.appveyor.com/api/projects/status/x1sjhd5q1jv1eupd?svg=true)](https://ci.appveyor.com/project/smockle/matrix)
-[![codecov](https://codecov.io/gh/smockle/matrix/branch/master/graph/badge.svg)](https://codecov.io/gh/smockle/matrix)
-[![Known Vulnerabilities](https://snyk.io/test/github/smockle/matrix/badge.svg)](https://snyk.io/test/github/smockle/matrix)
-[![Greenkeeper badge](https://badges.greenkeeper.io/smockle/matrix.svg)](https://greenkeeper.io/)
-
-# matrix
-
-Single or multi dimensional matrices and matrix functions.
-
-## Installation
-
-Run `npm install --save @smockle/matrix` to add `matrix` to your project.
-
-## Usage
-
-```JavaScript
-const Matrix = require('@smockle/matrix')
-
-// 1x1 Matrix
-const m11 = Matrix(3)
-
-// 1x3 Matrix
-const m13 = Matrix([1, 2, 3])
-
-// 3x1 Matrix
-const m31 = Matrix([[1], [2], [3]])
-```
-
-## API Reference
-{{#module name="matrix"}}
-{{>body~}}
-{{>member-index~}}
-{{>separator~}}
-{{>members~}}
-{{/module}}
-
-## Testing
-
-`matrix` includes several unit tests. After cloning the `matrix` repo locally, run `npm install` in the project folder to install dependencies. Run `npm test` to execute the tests.

package/lib/matrix.js

@@ -1,4 +0,0 @@
-// @flow
-
-require = require('@std/esm')(module)
-module.exports = require('./matrix.mjs').default

package/lib/matrix.mjs

@@ -1,312 +0,0 @@
-// @flow
-
-/** @module matrix */
-
-import fill from 'lodash/fill'
-import flattenDeep from 'lodash/flattenDeep'
-import padStart from 'lodash/padStart'
-import unzip from 'lodash/unzip'
-import mathjs from 'mathjs'
-const { inv } = mathjs
-
-/**
- * Creates a Matrix
- * @constructor
- * @alias module:matrix
- * @param {number|Array<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 | Array<number | Array<number>> */
-) /* : Matrix */ {
-  if (
-    (typeof x !== 'number' && !(x instanceof Array)) ||
-    // maltyped array contents
-    flattenDeep([].concat(x)).some(
-      (x /* : number */) => typeof x !== 'number'
-    ) ||
-    /* @flow disable */
-    (x[0] instanceof Array &&
-      // extra nesting
-      (x.length === 1 ||
-        // uneven rows
-        /* @flow disable */
-        x.some(row => row.length !== x[0].length)))
-  ) {
-    throw new TypeError('Matrix must be a number or array of numbers')
-  }
-
-  /**
-   * Single or multi dimensional matrix
-   * @constant {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 instanceof Matrix &&
-    y instanceof Matrix &&
-    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(
-    // prettier-ignore
-    (row /* : Array<number> */, i /* : number */)/* : Array<number> */ =>
-      row.map(
-        // prettier-ignore
-        (column /* : number */, j /* : number */)/* : number */ =>
-          column + y.__value[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 instanceof Matrix &&
-    y instanceof Matrix &&
-    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 /* : Array<number> */ = x.__value
-  const _y /* : Array<number> */ = unzip(y.__value) === []
-    ? unzip([y.__value])[i]
-    : unzip(y.__value)[i]
-  return [].concat(_x).reduce(
-    // prettier-ignore
-    (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')
-  }
-  /* @flow disable */
-  if (x.countColumns() === 0 && y.countRows() === 0) return Matrix(x * y)
-  /**
-   * New matrix with the dot product
-   * @const {Matrix}
-   */
-  const z /* : Matrix */ = Matrix(
-    fill(
-      Array(x.countRows()),
-      x.countRows() !== 1 ? fill(Array(y.countColumns()), 0) : 0
-    )
-  )
-  // prettier-ignore
-  return z.map(
-    (
-      _z /* : number | Array<number> */,
-      i /* : number */
-    )/* : number | Array<number> */ => {
-      if (typeof _z === 'number') return innerproduct(x, y, i)
-      return _z.map((_, j) => innerproduct({ __value: x.__value[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(x instanceof Matrix ? x.__value : x))
-}
-
-/**
- * Counts rows in this matrix
- * @alias module:matrix#countRows
- * @return {number} Number of rows
- */
-Matrix.prototype.countRows = function () /* : 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 () /* : 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 (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 (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 (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 (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 () /* : Matrix */ {
-  switch (this.countRows()) {
-    case 0:
-      return Matrix(this.__value)
-    case 1:
-      return Matrix(unzip([this.__value]))
-    default:
-      return Matrix(unzip(this.__value))
-  }
-}
-
-/**
- * Inverts this matrix
- * @alias module:matrix#invert
- * @return {Matrix} Matrix inverse
- */
-Matrix.prototype.invert = function () /* : Matrix */ {
-  return Matrix.invert(this)
-}
-
-/**
- * Maps over this matrix
- * @alias module:matrix#map
- * @return {Matrix} Matrix inverse
- */
-Matrix.prototype.map = function (x /* : Function */) /* : Matrix */ {
-  return Matrix(this.__value.map(x))
-}
-
-/**
- * Returns the number or number array value
- * @alias module:matrix#valueOf
- * @return {number|Array<number>} Number of number array value
- */
-/* @flow disable */
-Matrix.prototype.valueOf = function () /* : number | Array<number> */ {
-  return this.__value
-}
-
-/**
- * Formats and prints the matrix value
- * @alias module:matrix#inspect
- * @return {string} Formatted matrix value
- */
-Matrix.prototype.inspect = function () /* : string */ {
-  switch (this.countRows()) {
-    case 0:
-      return `${this.__value}`
-    case 1:
-      return `[ ${this.__value.join(' ')} ]`
-    default:
-      /**
-       * Output array filled with zeroes
-       * @constant {string}
-       */
-      const padding /* : Array<number> */ = unzip(
-        this.__value
-      ).map((column /* : Array<number> */) =>
-        column.reduce((length, x) => Math.max(`${x}`.length, length), 0)
-      )
-      return this.__value
-        .reduce(
-          (output, row) =>
-            `${output}[ ${row
-              .map((x, i) => padStart(x, padding[i]))
-              .join(' ')} ]`,
-          ''
-        )
-        .replace(/]\[/g, ']\n[')
-  }
-}
-
-export default Matrix