Sparsematrix

<a name="SparseMatrix"></a>

SparseMatrix

Sparse Matrix implementation. This type implements a Compressed Column Storage format for sparse matrices.

• instance
  • .storage() ⇒ <code>string</code>
  • .datatype() ⇒ <code>string</code>
  • .create(data, [datatype])
  • .density() ⇒ <code>number</code>
  • .subset(index, [replacement], [defaultValue])
  • .get(index) ⇒ <code>*</code>
  • .set(index, value, [defaultValue]) ⇒ <code>SparseMatrix</code>
  • .resize(size, [defaultValue], [copy]) ⇒ <code>Matrix</code>
  • .clone() ⇒ <code>SparseMatrix</code>
  • .size() ⇒ <code>Array.<number></code>
  • .map(callback, [skipZeros]) ⇒ <code>SparseMatrix</code>
  • .forEach(callback, [skipZeros])
  • .toArray() ⇒ <code>Array</code>
  • .valueOf() ⇒ <code>Array</code>
  • .format([options]) ⇒ <code>string</code>
  • .toString() ⇒ <code>string</code>
  • .toJSON() ⇒ <code>Object</code>
  • .diagonal([k]) ⇒ <code>Matrix</code>
  • .swapRows(i, j) ⇒ <code>Matrix</code>
• static
  • .fromJSON(json) ⇒ <code>SparseMatrix</code>
  • .diagonal(size, value, [k], [datatype]) ⇒ <code>SparseMatrix</code>

<a name="SparseMatrix+storage"></a>

sparseMatrix.storage() ⇒ <code>string</code>

Get the storage format used by the matrix.

Usage:

const format = matrix.storage()  // retrieve storage format

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>string</code> - The storage format.
<a name="SparseMatrix+datatype"></a>

sparseMatrix.datatype() ⇒ <code>string</code>

Get the datatype of the data stored in the matrix.

Usage:

const format = matrix.datatype()  // retrieve matrix datatype

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>string</code> - The datatype.
<a name="SparseMatrix+create"></a>

sparseMatrix.create(data, [datatype])

Create a new SparseMatrix

Kind: instance method of <code>SparseMatrix</code>

<a name="SparseMatrix+density"></a>

sparseMatrix.density() ⇒ <code>number</code>

Get the matrix density.

Usage:

const density = matrix.density()  // retrieve matrix density

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>number</code> - The matrix density.
<a name="SparseMatrix+subset"></a>

sparseMatrix.subset(index, [replacement], [defaultValue])

Get a subset of the matrix, or replace a subset of the matrix.

Usage:

const subset = matrix.subset(index)               // retrieve subset
const value = matrix.subset(index, replacement)   // replace subset

Kind: instance method of <code>SparseMatrix</code>

<a name="SparseMatrix+get"></a>

sparseMatrix.get(index) ⇒ <code>*</code>

Get a single element from the matrix.

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>*</code> - value

<a name="SparseMatrix+set"></a>

sparseMatrix.set(index, value, [defaultValue]) ⇒ <code>SparseMatrix</code>

Replace a single element in the matrix.

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>SparseMatrix</code> - self

<a name="SparseMatrix+resize"></a>

sparseMatrix.resize(size, [defaultValue], [copy]) ⇒ <code>Matrix</code>

Resize the matrix to the given size. Returns a copy of the matrix when copy=true, otherwise return the matrix itself (resize in place).

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>Matrix</code> - The resized matrix

<a name="SparseMatrix+clone"></a>

sparseMatrix.clone() ⇒ <code>SparseMatrix</code>

Create a clone of the matrix

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>SparseMatrix</code> - clone
<a name="SparseMatrix+size"></a>

sparseMatrix.size() ⇒ <code>Array.<number></code>

Retrieve the size of the matrix.

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>Array.<number></code> - size
<a name="SparseMatrix+map"></a>

sparseMatrix.map(callback, [skipZeros]) ⇒ <code>SparseMatrix</code>

Create a new matrix with the results of the callback function executed on each entry of the matrix.

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>SparseMatrix</code> - matrix

<a name="SparseMatrix+forEach"></a>

sparseMatrix.forEach(callback, [skipZeros])

Execute a callback function on each entry of the matrix.

Kind: instance method of <code>SparseMatrix</code>

<a name="SparseMatrix+toArray"></a>

sparseMatrix.toArray() ⇒ <code>Array</code>

Create an Array with a copy of the data of the SparseMatrix

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>Array</code> - array
<a name="SparseMatrix+valueOf"></a>

sparseMatrix.valueOf() ⇒ <code>Array</code>

Get the primitive value of the SparseMatrix: a two dimensions array

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>Array</code> - array
<a name="SparseMatrix+format"></a>

sparseMatrix.format([options]) ⇒ <code>string</code>

Get a string representation of the matrix, with optional formatting options.

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>string</code> - str

<a name="SparseMatrix+toString"></a>

sparseMatrix.toString() ⇒ <code>string</code>

Get a string representation of the matrix

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>string</code> - str
<a name="SparseMatrix+toJSON"></a>

sparseMatrix.toJSON() ⇒ <code>Object</code>

Get a JSON representation of the matrix

Kind: instance method of <code>SparseMatrix</code>
<a name="SparseMatrix+diagonal"></a>

sparseMatrix.diagonal([k]) ⇒ <code>Matrix</code>

Get the kth Matrix diagonal.

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>Matrix</code> - The matrix vector with the diagonal values.

<a name="SparseMatrix+swapRows"></a>

sparseMatrix.swapRows(i, j) ⇒ <code>Matrix</code>

Swap rows i and j in Matrix.

Kind: instance method of <code>SparseMatrix</code>
Returns: <code>Matrix</code> - The matrix reference

<a name="SparseMatrix.fromJSON"></a>

SparseMatrix.fromJSON(json) ⇒ <code>SparseMatrix</code>

Generate a matrix from a JSON object

Kind: static method of <code>SparseMatrix</code>

<a name="SparseMatrix.diagonal"></a>

SparseMatrix.diagonal(size, value, [k], [datatype]) ⇒ <code>SparseMatrix</code>

Create a diagonal matrix.

Kind: static method of <code>SparseMatrix</code>