matrix.md

Table of Contents

• Matrix
  • Parameters
  • isCommutative
    • Parameters
    • Examples
  • add
    • Parameters
    • Examples
  • product
    • Parameters
    • Examples
  • dot
    • Parameters
    • Examples

Matrix

src/modules/matrix.js:8-103

Matrix module for DataFrame, providing basic mathematical matrix computations.

Parameters

• df DataFrame An instance of DataFrame.

isCommutative

src/modules/matrix.js:26-34

Check if two DataFrames are commutative, if both have the same dimensions.

Parameters

• df DataFrame The second DataFrame to check.
• reverse Boolean Revert the second DataFrame before the comparison. (optional, default false)

Examples

df.matrix.isCommutative(df2)

Returns Boolean True if they are commutative, else false.

add

src/modules/matrix.js:43-58

Provide an elements pairwise addition of two DataFrames having the same dimensions.

Parameters

• df DataFrame The second DataFrame to add.

Examples

df.matrix.add(df2)

Returns DataFrame A new DataFrame resulting to the addition two DataFrames.

product

src/modules/matrix.js:67-71

Provide a scalar product between a number and a DataFrame.

Parameters

• number Number The number to multiply.

Examples

df.matrix.product(6)

Returns DataFrame A new DataFrame resulting to the scalar product.

dot

src/modules/matrix.js:80-102

Multiply one DataFrame n x p and a second p x n.

Parameters

• df DataFrame The second DataFrame to multiply.

Examples

df.matrix.dot(df)

Returns DataFrame A new n x n DataFrame resulting to the product of two DataFrame.