fr.cnes.sirius.patrius.math.linear

Interface SymmetricMatrix

All Superinterfaces:

AnyMatrix, RealMatrix, Serializable

All Known Subinterfaces:

SymmetricPositiveMatrix

All Known Implementing Classes:

ArrayRowSymmetricMatrix, DecomposedSymmetricPositiveMatrix, DiagonalMatrix

public interface SymmetricMatrix
extends RealMatrix

Interface for symmetric matrices.

Method Summary

Modifier and Type	Method and Description
SymmetricMatrix	add(SymmetricMatrix m) Adds a SymmetricMatrix to this matrix.
SymmetricMatrix	copy() Returns a (deep) copy of this.
SymmetricMatrix	extractSubSymmetricMatrix(int[] index) Extract a sub-part of the matrix providing a subset of indices.
SymmetricMatrix	getInverse() Get the inverse of the decomposed matrix.
SymmetricMatrix	getInverse(Function<RealMatrix,Decomposition> decompositionBuilder) Get the inverse matrix computed with the given decomposition algorithm.
SymmetricMatrix	power(int p) Returns the result of multiplying this with itself p times.
SymmetricMatrix	quadraticMultiplication(RealMatrix m) Gets the result of the quadratic multiplication M×S×MT, where S is this matrix and M is the provided matrix.
SymmetricMatrix	quadraticMultiplication(RealMatrix m, boolean toTranspose) Gets the result of the quadratic multiplication M×S×MT, where S is this matrix and M or MT is the provided matrix.
SymmetricMatrix	scalarAdd(double d) Adds a scalar to each entry of this matrix.
SymmetricMatrix	scalarMultiply(double d) Multiplies each entry of this matrix by a scalar.
SymmetricMatrix	subtract(SymmetricMatrix m) Subtracts a SymmetricMatrix from this matrix.
SymmetricMatrix	transpose() Returns the transpose of this matrix.

Methods inherited from interface fr.cnes.sirius.patrius.math.linear.RealMatrix

add, addToEntry, concatenateDiagonally, concatenateHorizontally, concatenateHorizontally, concatenateVertically, concatenateVertically, copySubMatrix, copySubMatrix, copySubMatrix, copySubMatrix, createMatrix, equals, getColumn, getColumnMatrix, getColumnVector, getData, getData, getDefaultDecomposition, getEntry, getFrobeniusNorm, getMax, getMin, getNorm, getRow, getRowMatrix, getRowVector, getSubMatrix, getSubMatrix, getTrace, isAntisymmetric, isDiagonal, isInvertible, isOrthogonal, isPositiveDefinite, isSymmetric, isSymmetric, isSymmetric, multiply, multiply, multiply, multiplyEntry, operate, operate, preMultiply, preMultiply, preMultiply, setColumn, setColumnMatrix, setColumnVector, setDefaultDecomposition, setEntry, setRow, setRowMatrix, setRowVector, setSubMatrix, subtract, toString, transpose, walkInColumnOrder, walkInColumnOrder, walkInColumnOrder, walkInColumnOrder, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder, walkInRowOrder, walkInRowOrder, walkInRowOrder, walkInRowOrder

Methods inherited from interface fr.cnes.sirius.patrius.math.linear.AnyMatrix

getColumnDimension, getRowDimension, isSquare

Method Detail

scalarMultiply

SymmetricMatrix scalarMultiply(double d)

Multiplies each entry of this matrix by a scalar.

Specified by:

scalarMultiply in interface RealMatrix

Parameters:

d - the scalar by which each entry is multiplied

Returns:

the matrix resulting from this multiplication

scalarAdd

SymmetricMatrix scalarAdd(double d)

Adds a scalar to each entry of this matrix.

Specified by:

scalarAdd in interface RealMatrix

Parameters:

d - the scalar to add to each entry

Returns:

the matrix resulting from this addition

add

SymmetricMatrix add(SymmetricMatrix m)

Adds a SymmetricMatrix to this matrix.

Parameters:

m - the matrix to add

Returns:

the matrix resulting from this addition

subtract

SymmetricMatrix subtract(SymmetricMatrix m)

Subtracts a SymmetricMatrix from this matrix.

Parameters:

m - the matrix to subtract

Returns:

the matrix resulting from this subtraction

quadraticMultiplication

SymmetricMatrix quadraticMultiplication(RealMatrix m)

Gets the result of the quadratic multiplication M×S×M^T, where S is this matrix and M is the provided matrix.

Parameters:

m - the matrix M

Returns:

M×S×M^T

quadraticMultiplication

SymmetricMatrix quadraticMultiplication(RealMatrix m,
                                        boolean toTranspose)

Gets the result of the quadratic multiplication M×S×M^T, where S is this matrix and M or M^T is the provided matrix.

Parameters:

m - the matrix M or the matrix M^T

toTranspose - if true, assume the provided matrix is M^T, otherwise assumes it is M

Returns:

M×S×M^T

extractSubSymmetricMatrix

SymmetricMatrix extractSubSymmetricMatrix(int[] index)

Extract a sub-part of the matrix providing a subset of indices. It also allows to permute the rows/columns.

 Usage example (with permutation):
        1        2        3                            2       3        1
   1 [lambda1,      mu,   gamma]                 2 [lambda2,    beta,      mu]
   2 [     mu, lambda2,    beta] --> {2,3,1} --> 3 [   beta, lambda3,   gamma]
   3 [  gamma,    beta, lambda3]                 1 [     mu,   gamma, lambda1]
 

 Usage example :
        1        2        3                            2       3        
   1 [lambda1,      mu,   gamma]                 2 [lambda2,    beta]
   2 [     mu, lambda2,    beta] --> {2,3}   --> 3 [   beta, lambda3]
   3 [  gamma,    beta, lambda3]                
 

Parameters:

index - Index list

Returns:

extracted matrix

copy

SymmetricMatrix copy()

Returns a (deep) copy of this.

Specified by:

copy in interface RealMatrix

Returns:

matrix copy

transpose

SymmetricMatrix transpose()

Returns the transpose of this matrix.

Specified by:

transpose in interface RealMatrix

Returns:

transpose matrix

power

SymmetricMatrix power(int p)

Returns the result of multiplying this with itself p times. Depending on the underlying storage, instability for high powers might occur.

Specified by:

power in interface RealMatrix

Parameters:

p - raise this to power p

Returns:

this^p

getInverse

SymmetricMatrix getInverse()

Get the inverse of the decomposed matrix. The default decomposition can be changed using the setDefaultDecomposition(Function) method.

Specified by:

getInverse in interface RealMatrix

Returns:

inverse matrix

Throws:

SingularMatrixException - if the decomposed matrix is singular.

getInverse

SymmetricMatrix getInverse(Function<RealMatrix,Decomposition> decompositionBuilder)

Get the inverse matrix computed with the given decomposition algorithm.

Warning: If a matrix has already been given to the decomposition, it won't be taken into account, as a new computation will be run on this matrix and will erase the old decomposition data.

Specified by:

getInverse in interface RealMatrix

Parameters:

decompositionBuilder - decomposition function to use

Returns:

inverse matrix

Throws:

SingularMatrixException - if the decomposed matrix is singular.