Matrix Type

Matrix provides the fundamental operations of numerical linear algebra.

Constructors

Constructor Description

Matrix(rows, columns)

Full Usage: Matrix(rows, columns)

Parameters:
    rows : int - Number of rows.
    columns : int - Number of columns.

Constructs an empty matrix of the given size.

rows : int

Number of rows.

columns : int

Number of columns.

Matrix(rows, columns, value)

Full Usage: Matrix(rows, columns, value)

Parameters:
    rows : int - Number of rows.
    columns : int - Number of columns.
    value : float - Value to assign to the diagnoal elements.

Constructs a matrix of the given size and assigns a given value to all diagonal elements.

rows : int

Number of rows.

columns : int

Number of columns.

value : float

Value to assign to the diagnoal elements.

Matrix(data)

Full Usage: Matrix(data)

Parameters:
    data : float[][] - The array the matrix gets constructed from.

Constructs a matrix from the given array.

data : float[][]

The array the matrix gets constructed from.

Instance members

Instance member Description

this.Addition

Full Usage: this.Addition

Parameters:
Returns: IMapackMatrix
Modifiers: abstract

Matrix addition.

B : IMapackMatrix
Returns: IMapackMatrix

this.Clone

Full Usage: this.Clone

Returns: IMapackMatrix
Modifiers: abstract

Creates a copy of the matrix.

Returns: IMapackMatrix

this.ColumnCount

Full Usage: this.ColumnCount

Returns: int
Modifiers: abstract

Returns the number of columns.

Returns: int

this.Determinant

Full Usage: this.Determinant

Returns: float
Modifiers: abstract

Determinant if matrix is square.

Returns: float

this.FrobeniusNorm

Full Usage: this.FrobeniusNorm

Returns: float
Modifiers: abstract

Returns the Frobenius Norm for the matrix.

Returns: float

this.GetCholeskyDecomposition

Full Usage: this.GetCholeskyDecomposition

Returns: ICholeskyDecomposition
Modifiers: abstract

Returns the cholesky decomposition for this matrix.

Returns: ICholeskyDecomposition

this.GetEigenvalueDecomposition

Full Usage: this.GetEigenvalueDecomposition

Returns: IEigenvalueDecomposition
Modifiers: abstract

Returns the eigenvalue decomposition for this matrix.

Returns: IEigenvalueDecomposition

this.GetLuDecomposition

Full Usage: this.GetLuDecomposition

Returns: ILuDecomposition
Modifiers: abstract

Returns the LU decomposition for this matrix.

Returns: ILuDecomposition

this.GetQrDecomposition

Full Usage: this.GetQrDecomposition

Returns: IQrDecomposition
Modifiers: abstract

Returns the QR decomposition for this matrix.

Returns: IQrDecomposition

this.GetSingularValueDecomposition

Full Usage: this.GetSingularValueDecomposition

Returns: ISingularValueDecomposition
Modifiers: abstract

Returns the singular value decomposition for this matrix.

Returns: ISingularValueDecomposition

this.InfinityNorm

Full Usage: this.InfinityNorm

Returns: float
Modifiers: abstract

Returns the Infinity Norm for the matrix.

Returns: float

this.Inverse

Full Usage: this.Inverse

Returns: IMapackMatrix
Modifiers: abstract

Inverse of the matrix if matrix is square, pseudoinverse otherwise.

Returns: IMapackMatrix

this.IsSquare

Full Usage: this.IsSquare

Returns: bool
Modifiers: abstract

Return if the matrix is a square matrix.

Returns: bool

this.IsSymmetric

Full Usage: this.IsSymmetric

Returns: bool
Modifiers: abstract

Returns if the matrix is symmetric.

Returns: bool

this.[arg1, arg2]

Full Usage: this.[arg1, arg2]

Parameters:
    arg0 : int

Returns: int
Modifiers: abstract

Access the value at the given location.

arg0 : int
Returns: int

this.Multiply

Full Usage: this.Multiply

Parameters:
    s : float

Returns: IMapackMatrix
Modifiers: abstract

Matrix-scalar multiplication.

s : float
Returns: IMapackMatrix

this.Multiply

Full Usage: this.Multiply

Parameters:
Returns: IMapackMatrix
Modifiers: abstract

Matrix-matrix multiplication.

B : IMapackMatrix
Returns: IMapackMatrix

this.Norm1

Full Usage: this.Norm1

Returns: float
Modifiers: abstract

Returns the One Norm for the matrix.

Returns: float

this.RowCount

Full Usage: this.RowCount

Returns: int
Modifiers: abstract

Returns the number of columns.

Returns: int

this.Solve

Full Usage: this.Solve

Parameters:
Returns: IMapackMatrix
Modifiers: abstract

Returns the LHS solution vetor if the matrix is square or the least squares solution otherwise.

rhs : IMapackMatrix
Returns: IMapackMatrix

this.Submatrix

Full Usage: this.Submatrix

Parameters:
    i0 : int - Starttial row index
    i1 : int - End row index
    j0 : int - Start column index
    j1 : int - End column index

Returns: IMapackMatrix
Modifiers: abstract

Returns a sub matrix extracted from the current matrix.

i0 : int

Starttial row index

i1 : int

End row index

j0 : int

Start column index

j1 : int

End column index

Returns: IMapackMatrix

this.Submatrix

Full Usage: this.Submatrix

Parameters:
    r : int[] - Array of row indices
    c : int[] - Array of row indices

Returns: IMapackMatrix
Modifiers: abstract

Returns a sub matrix extracted from the current matrix.

r : int[]

Array of row indices

c : int[]

Array of row indices

Returns: IMapackMatrix

this.Submatrix

Full Usage: this.Submatrix

Parameters:
    i0 : int - Starttial row index
    i1 : int - End row index
    c : int[] - Array of row indices

Returns: IMapackMatrix
Modifiers: abstract

Returns a sub matrix extracted from the current matrix.

i0 : int

Starttial row index

i1 : int

End row index

c : int[]

Array of row indices

Returns: IMapackMatrix

this.Submatrix

Full Usage: this.Submatrix

Parameters:
    r : int[] - Array of row indices
    j0 : int - Start column index
    j1 : int - End column index

Returns: IMapackMatrix
Modifiers: abstract

Returns a sub matrix extracted from the current matrix.

r : int[]

Array of row indices

j0 : int

Start column index

j1 : int

End column index

Returns: IMapackMatrix

this.Subtraction

Full Usage: this.Subtraction

Parameters:
Returns: IMapackMatrix
Modifiers: abstract

Matrix subtraction.

B : IMapackMatrix
Returns: IMapackMatrix

this.ToString

Full Usage: this.ToString

Returns: string
Modifiers: abstract

Returns the matrix in a textual form.

Returns: string

this.Trace

Full Usage: this.Trace

Returns: float Sum of the diagonal elements.
Modifiers: abstract

Returns the trace of the matrix.

Returns: float

Sum of the diagonal elements.

this.Transpose

Full Usage: this.Transpose

Returns: IMapackMatrix
Modifiers: abstract

Returns the transposed matrix.

Returns: IMapackMatrix

this.UnaryMinus

Full Usage: this.UnaryMinus

Returns: IMapackMatrix

Unary minus.

Returns: IMapackMatrix

Static members

Static member Description

Matrix.Diagonal(rows, columns, value)

Full Usage: Matrix.Diagonal(rows, columns, value)

Parameters:
    rows : int
    columns : int
    value : float

Returns: IMapackMatrix

Returns a diagonal matrix of the given size.

rows : int
columns : int
value : float
Returns: IMapackMatrix

Matrix.Random(rows, columns)

Full Usage: Matrix.Random(rows, columns)

Parameters:
    rows : int
    columns : int

Returns: IMapackMatrix

Returns a matrix filled with random values.

rows : int
columns : int
Returns: IMapackMatrix