module arrays.API

Table of Contents generated with DocToc

• Module: arrays
  • arrays
    • add(a1, a2) → {Array.<Array.>}
    • Methods
      • copy(arrays) → {Array.<Array.>}
      • createBlank(numOfRows, numOfCols) → {Array.<Array.>}
      • createIdentity(size) → {Array.<Array.>}
      • decompose(arrays) → {LUP}
      • getDimensions(arrays) → {Array.}
      • getNumOfColumns(arrays) → {Integer}
      • getNumOfRows(arrays) → {Integer}
      • getSize(arrays) → {String}
      • invert(arrays) → {Array.<Array.>}
      • isEmpty(arrays) → {Boolean}
      • isLowerTriangular(arrays) → {Boolean}
      • isSquare(arrays) → {Boolean}
      • isUpperTriangular(arrays) → {Boolean}
      • multiply(a1, a2) → {Array.<Array.>}
      • solve(A, b) → {Array.<Array.>}
      • subtract(a1, a2) → {Array.<Array.>}
      • transpose(arrays) → {Array.<Array.>}
      • <private, inner> solve(lup, b) → {Array.<Array.>}
    • Type Definitions
      • LUP

Module: arrays

arrays

API for dealing with matrices as simple 2D arrays.

Source:

• arrays.js , lineno 3

Methods

<static> add(a1, a2) → {Array.<Array.<Number>>}

Add two 2D arrays and return the result.

Parameters:

Name	Type	Description
a1	Array.<Array.<Number>>
a2	Array.<Array.<Number>>

Source:

• arrays.js , lineno 266

Returns:

Type

Array.<Array.<Number>>

<static> copy(arrays) → {Array.<Array.<Number>>}

Parameters:

Name	Type	Description
arrays	!Array.<Array.<Number>>	2D array to copy.

Source:

• arrays.js , lineno 80

Returns:

Type

Array.<Array.<Number>>

<static> createBlank(numOfRows, numOfCols) → {Array.<Array.<Number>>}

Parameters:

Name	Type	Argument	Default	Description
numOfRows	Integer
numOfCols	Integer	<optional>	numOfRows

Source:

• arrays.js , lineno 50

Returns:

The blank (zeros) 2D array of given size.

Type

Array.<Array.<Number>>

<static> createIdentity(size) → {Array.<Array.<Number>>}

Parameters:

Name	Type	Description
size	Integer

Source:

• arrays.js , lineno 22

Returns:

The identity 2D array of given size.

Type

Array.<Array.<Number>>

<static> decompose(arrays) → {LUP}

Decompose this 2D array into lower and upper triangular 2D arrays.

Parameters:

Name	Type	Description
arrays	Array.<Array.<Number>>

Source:

• arrays.js , lineno 326

Throws:

SingularMatrixException

Returns:

Lower and upper triangular 2D arrays, and a permutation 2D array.

Type

LUP

<static> getDimensions(arrays) → {Array.<Integer>}

Parameters:

Name	Type	Description
arrays	!Array.<Array.<Number>>

Source:

• arrays.js , lineno 162

Returns:

e.g. [2, 3] for a 2x3 matrix

Type

Array.<Integer>

<static> getNumOfColumns(arrays) → {Integer}

Parameters:

Name	Type	Description
arrays	!Array.<Array.<Number>>

Source:

• arrays.js , lineno 134

Returns:

Type

Integer

<static> getNumOfRows(arrays) → {Integer}

Parameters:

Name	Type	Description
arrays	!Array.<Array.<Number>>

Source:

• arrays.js , lineno 148

Returns:

Type

Integer

<static> getSize(arrays) → {String}

Get a string representation of the 2D array size.

Parameters:

Name	Type	Description
arrays	!Array.<Array.<Number>>

Source:

• arrays.js , lineno 173

Returns:

Type

String

<static> invert(arrays) → {Array.<Array.<Number>>}

Return an inverted version of the given 2D array.

Parameters:

Name	Type	Description
arrays	Array.<Array.<Number>>

Source:

• arrays.js , lineno 474

Returns:

Type

Array.<Array.<Number>>

<static> isEmpty(arrays) → {Boolean}

Parameters:

Name	Type	Description
arrays	!Array.<Array.<Number>>

Source:

• arrays.js , lineno 106

Returns:

Type

Boolean

<static> isLowerTriangular(arrays) → {Boolean}

Parameters:

Name	Type	Description
arrays	!Array.<Array.<Number>>

Source:

• arrays.js , lineno 185

Returns:

Type

Boolean

<static> isSquare(arrays) → {Boolean}

Parameters:

Name	Type	Description
arrays	!Array.<Array.<Number>>

Source:

• arrays.js , lineno 120

Returns:

Type

Boolean

<static> isUpperTriangular(arrays) → {Boolean}

Parameters:

Name	Type	Description
arrays	!Array.<Array.<Number>>

Source:

• arrays.js , lineno 210

Returns:

Type

Boolean

<static> multiply(a1, a2) → {Array.<Array.<Number>>}

Multiple two 2D arrays and return the result.

Parameters:

Name	Type	Description
a1	Array.<Array.<Number>>
a2	Array.<Array.<Number>>

Source:

• arrays.js , lineno 294

Returns:

Type

Array.<Array.<Number>>

<static> solve(A, b) → {Array.<Array.<Number>>}

Solve the matrix equation Ax = b for x with matrix size N.

Parameters:

Name	Type	Description
A	Array.<Array.<Number>>	NxN
b	Array.<Array.<Number>>	Nx1

Source:

• arrays.js , lineno 396

Returns:

Nx1

Type

Array.<Array.<Number>>

<static> subtract(a1, a2) → {Array.<Array.<Number>>}

Subtract a2 from a1 and return the result.

Parameters:

Name	Type	Description
a1	Array.<Array.<Number>>
a2	Array.<Array.<Number>>

Source:

• arrays.js , lineno 280

Returns:

Type

Array.<Array.<Number>>

<static> transpose(arrays) → {Array.<Array.<Number>>}

Return a transposed version of the given 2D array.

Parameters:

Name	Type	Description
arrays	Array.<Array.<Number>>

Source:

• arrays.js , lineno 449

Returns:

Type

Array.<Array.<Number>>

<private, inner> solve(lup, b) → {Array.<Array.<Number>>}

Parameters:

Name	Type	Description
lup	LUP
b	Array.<Array.<Number>>

Source:

• arrays.js , lineno 414

Returns:

Type

Array.<Array.<Number>>

Type Definitions

LUP

Type:

• object

Properties:

Name	Type	Description
l	Array.<Array.<Number>>	Lower triangular matrix.
u	Array.<Array.<Number>>	Upper triangular matrix.
p	Array.<Array.<Number>>	Permutation matrix.

Source:

• arrays.js , lineno 310

Generated with wicked.