Densematrix

<a name="DenseMatrix"></a>

DenseMatrix

Dense Matrix implementation. This type implements an efficient Array format for dense matrices.

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

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

denseMatrix.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>DenseMatrix</code> Returns: <code>string</code> - The storage format.
<a name="DenseMatrix+datatype"></a>

denseMatrix.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>DenseMatrix</code> Returns: <code>string</code> - The datatype.
<a name="DenseMatrix+create"></a>

denseMatrix.create(data, [datatype])

Create a new DenseMatrix

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

<a name="DenseMatrix+subset"></a>

denseMatrix.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>DenseMatrix</code>

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

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

Get a single element from the matrix.

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

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

denseMatrix.set(index, value, [defaultValue]) ⇒ <code>DenseMatrix</code>

Replace a single element in the matrix.

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

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

denseMatrix.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>DenseMatrix</code> Returns: <code>Matrix</code> - The resized matrix

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

denseMatrix.clone() ⇒ <code>DenseMatrix</code>

Create a clone of the matrix

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

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

Retrieve the size of the matrix.

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

denseMatrix.map(callback) ⇒ <code>DenseMatrix</code>

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

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

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

denseMatrix.forEach(callback)

Execute a callback function on each entry of the matrix.

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

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

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

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

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

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

Get the primitive value of the DenseMatrix: a multidimensional array

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

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

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

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

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

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

Get a string representation of the matrix

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

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

Get a JSON representation of the matrix

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

denseMatrix.diagonal([k]) ⇒ <code>Array</code>

Get the kth Matrix diagonal.

Kind: instance method of <code>DenseMatrix</code> Returns: <code>Array</code> - The array vector with the diagonal values.

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

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

Swap rows i and j in Matrix.

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

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

DenseMatrix.diagonal(size, value, [k], [defaultValue]) ⇒ <code>DenseMatrix</code>

Create a diagonal matrix.

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

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

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

Generate a matrix from a JSON object

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

<a name="DenseMatrix.preprocess"></a>

DenseMatrix.preprocess(data) ⇒ <code>Array</code>

Preprocess data, which can be an Array or DenseMatrix with nested Arrays and Matrices. Replaces all nested Matrices with Arrays

Kind: static method of <code>DenseMatrix</code> Returns: <code>Array</code> - data