| Documentation

Matrix_Class_Error_Message
Matrix_Class_Error_Message
Matrix ▸
- Static members
- .Error_Message
- .randomInt
- .array_mult
- .fromArray
- .diagonal
- .random
- .map
- .add
- .sub
- .mult
- .div
- .prod
- .invert
- .deserialize
- Instance members
- #show
- #dim
- #random
- #toArray
- #toArray_flat
- #toString
- #serialize
- #reduce
- #map
- #row_map
- #col_map
- #copy
- #unit
- #diagonal
- #fill
- #transpose
- #invert
- #add
- #sub
- #mult
- #div
- #triangle
- #isTriangle
- #hasEmpty
- #determinant
- #solveLGS

Need help reading this?

Matrix_Class_Error_Message

Performs simple matrix math

Matrix_Class_Error_Message

Version: 1.0.0

Author: AvoLord

Matrix_Class_Error_Message

Sets the Error-messages and the state

Matrix_Class_Error_Message

Matrix

Creates a new matrix-object with given rows, columns and fill

new Matrix(rows: Number, columns: Number, fill: Number)

Parameters

rows (Number) The amount of rows of the matrix

columns (Number) The amount of columns of the matrix

fill (Number) The number with wich the matrix will be filled

Static Members

▸ Error_Message()

Toggels if Error messages are displayed

Error_Message()

▸ randomInt(min, max)

Creates a random Integer

randomInt(min: Number, max: Number): Number

Parameters

min (Number) The minimum random number

max (Number) The maximum random number

Returns

Number: A random number between min and max

▸ array_mult(a1, a2)

The scalar-multiplication of two arrays seen as vectors

array_mult(a1: Object, a2: Object): Object

Parameters

a1 (Object) The first array / vector

a2 (Object) The second array / vector

Returns

Object: The scalar-product of two "vectors"

▸ fromArray(array)

Creates matrix-object from a two-dimensional array

fromArray(array: Object): Object

Parameters

array (Object) The array that will be converted to a matrix

Returns

Object: A new matrix-object with the values form the array

▸ diagonal(M1, diagonal_num, filler, diagnonal_num)

Creates a diagnonal matrix-object

diagonal(M1: Object, diagonal_num: any, filler: Number, diagnonal_num: Number): Object

Parameters

M1 (Object) The matrix that will be cloned and converted

diagonal_num (any)

filler (Number) The number that will fill the result

diagnonal_num (Number) The number that will fill the diagonal line

Returns

Object: A new matrix with the same dimensions as the input-matrix but with a new set of numbers

▸ random(M1, min, max)

Creates a matrix-object with random numbers

random(M1: Object, min: Number, max: Number): Object

Parameters

M1 (Object) The matrix that will be cloned and converted

min (Number) The minimum random number

max (Number) The maximum random number

Returns

Object: A new matrix with the same dimensions as the input-matrix but with random numbers randing form min to max

▸ map(M1, func)

Creates a matrix on which a function has been mapped to

map(M1: Object, func: function): Object

Parameters

M1 (Object) The Matrix that will be cloned and converted

func (function) The function that will alter the elements of the matrix

Returns

Object: A new matrix with the same dimensions as the input-matrix but with a new set of numbers

▸ add(M1, Obj)

Creates a new matrix from the sum of the elements of two matrices or a matrix and a number

add(M1: Object, Obj: Object): Object

Parameters

M1 (Object) The matrix that will be cloned and converted

Obj (Object) The matrix whose elements will be added to the elements of M1

Returns

Object: A new Matrix with the same dimensions as the input Matrix but with a new set of numbers

▸ sub(M1, Obj)

Creates a new matrix from the difference of the elements of two matrices or a matrix and a number

sub(M1: Object, Obj: Object): Object

Parameters

M1 (Object) The matrix that will be cloned and converted

Obj (Object) The matrix whose elements will be subtracted from the elements of M1

Returns

Object: A new Matrix with the same dimensions as the input Matrix but with a new set of numbers

▸ mult(M1, Obj)

Creates a new matrix from the product of the elements of two matrices or a matrix and a number

mult(M1: Object, Obj: Object): Object

Parameters

M1 (Object) The matrix that will be cloned and converted

Obj (Object) The matrix whose elements will be multiplied by the elements of M1

Returns

Object: A new Matrix with the same dimensions as the input Matrix but with a new set of numbers

▸ div(M1, Obj)

Creates a new matrix from the division of the elements of two matrices or a matrix and a number

div(M1: Object, Obj: Object): Object

Parameters

M1 (Object) The matrix that will be cloned and converted

Obj (Object) The matrix whose elements will be divided by the elements of M1

Returns

Object: A new Matrix with the same dimensions as the input Matrix but with a new set of numbers

▸ prod(M1, M2)

Creates a new matrix from the multiplication of two matrices

prod(M1: Object, M2: Object): Object

Parameters

M1 (Object) The first matrix

M2 (Object) The second matrix that will be multiplied with the first

Returns

Object: The Product of the matrix multiplication

▸ invert(M1)

Creates a new matrix whose values are inverted

invert(M1: Object): Object

Parameters

M1 (Object) The matrix that will be cloned and converted

Returns

Object: A new matrix with the same dimensions as the input-matrix but with an inverted set of numbers

▸ deserialize(data)

Creates a new matrix-object from a JSON-file

deserialize(data: any): any

Parameters

data (any) The JSON-file that contains all the necessary information of a matrix-object

Returns

any: A new matrix-objet with the information of the JSON-file

Instance Members

▸ show()

Shows the contents of the matrix in the console

show()

▸ dim()

Returns the dimensions of the matrix

dim(): Array

Returns

Array: Dimensions [rows, columns]

▸ random(min, max)

Randomizes the elements of a matrix

random(min: Number, max: Number)

Parameters

min (Number) The minimum random number

max (Number) The maximum random number

▸ toArray()

Represents a matrix as a two-dimensional array

toArray(): any

Returns

any: An array with the elements of the input-matrix

▸ toArray_flat()

Represents a matrix as a one-dimensional array

toArray_flat(): any

Returns

any: An array with the elements of the input-matrix

▸ toString()

Represents a matrix as a string

toString(): any

Returns

any: A string with the elements of the input-matrix

▸ serialize()

Represents a matrix-object as a JSON-file

serialize(): any

Returns

any: A JSON-file with the elements of the input-matrix-object

▸ reduce()

Creates the sum of all elements of the matrix

reduce(): any

Returns

any: The sum of all the elements of the input-matrix

▸ map(func)

Maps a function to all elements of the matrix

map(func: function)

Parameters

func (function) The function that will be mapped to the matrix elements

▸ row_map(row, func)

Maps a function to a specific row of elements of the matrix

row_map(row: Number, func: function)

Parameters

row (Number) The targeted row

func (function) The function that will be mapped to the matrix elements

▸ col_map(col, func)

Maps a function to a specific collumn of elements of the matrix

col_map(col: Number, func: function)

Parameters

col (Number) The targeted collumn

func (function) The function that will be mapped to the matrix elements

▸ copy()

Creates a copy of a matrix-object

copy(): any

Returns

any: A copy of the input-matrix

▸ unit()

Converts the matrix to a unit-matrix

unit()

▸ diagonal(diagonal_num, filler)

Converts the matrix to a diagonal matrix with custom infill

diagonal(diagonal_num: Number, filler: Number)

Parameters

diagonal_num (Number) The value of the diagonal line

filler (Number) The value that the other elements will have

▸ fill(filler)

Fills the matrix with a specified number

fill(filler: Number)

Parameters

filler (Number) the number with wich the matrix will be filled

▸ transpose()

Creates the transposed version of a matrix

transpose(): any

Returns

any: The transposed matrix

▸ invert()

Inverts the elements of a matrix

invert()

▸ add(Obj)

Adds elements of another matrix or a number to the initial matrix

add(Obj: Object)

Parameters

Obj (Object) The matrix whose elements are added to the elements of the initial matrix

▸ sub(Obj)

Subtracts elements of another matrix or a number from the initial matrix

sub(Obj: Object)

Parameters

Obj (Object) The matrix whose elements are subtracted from the elements of the initial matrix

▸ mult(Obj)

Multiplies elements of another matrix or a number with the initial matrix

mult(Obj: Object)

Parameters

Obj (Object) The matrix whose elements multiply the elements of the initial matrix

▸ div(Obj)

Divides elements of the initial matrix by the elements of another matrix or number

div(Obj: Object)

Parameters

Obj (Object) The matrix whose elements divide the elements of the initial matrix

▸ triangle(above, below)

Transforms a matrix to a "triangle-form"

triangle(above: Boolean, below: Boolean)

Parameters

above

(Boolean
            = true)

Converts the upper-right corner

below

(Boolean
            = false)

Converts the lower-left corner

▸ isTriangle()

Checks if a matrix is in a "triangle-form"

isTriangle(): Boolean

Returns

Boolean: Matrix is in triangle-form

▸ hasEmpty()

Checks if a matrix has empty rows or collumns

hasEmpty(): Boolean

Returns

Boolean: Matrix has empty rows or collumns

▸ determinant(iterations)

Calculates the determinant of a matrix

determinant(iterations: Number): Number

Parameters

iterations

(Number
            = 0)

The amount of recursion that occurred

Returns

Number: the determinant of the matrix

▸ solveLGS(iterations)

Solves a system of linear equations represented as a matrix

solveLGS(iterations: Number): Array

Parameters

iterations (Number) The amount of recursion that occurred

Returns

Array: The solved variables