fr.cnes.sirius.patrius.math.linear

Interface SymmetricPositiveMatrix

All Superinterfaces:

AnyMatrix, RealMatrix, Serializable, SymmetricMatrix

All Known Implementing Classes:

DecomposedSymmetricPositiveMatrix

public interface SymmetricPositiveMatrix
extends SymmetricMatrix

Interface for symmetric positive semi-definite matrices.

Method Summary

Modifier and Type	Method and Description
SymmetricPositiveMatrix	add(SymmetricPositiveMatrix m) Adds a SymmetricPositiveMatrix to this matrix.
SymmetricPositiveMatrix	copy() Returns a (deep) copy of this.
SymmetricPositiveMatrix	getInverse() Get the inverse of the decomposed matrix.
SymmetricPositiveMatrix	getInverse(Function<RealMatrix,Decomposition> decompositionBuilder) Get the inverse matrix computed with the given decomposition algorithm.
SymmetricPositiveMatrix	positiveScalarAdd(double d) Adds a positive scalar to each entry of this matrix.
SymmetricPositiveMatrix	positiveScalarMultiply(double d) Multiplies each entry of this matrix by a positive scalar.
SymmetricPositiveMatrix	power(int p) Returns the result of multiplying this with itself p times.
SymmetricPositiveMatrix	quadraticMultiplication(RealMatrix m) Gets the result of the quadratic multiplication M×S×MT, where S is this matrix and M is the provided matrix.
SymmetricPositiveMatrix	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.
SymmetricPositiveMatrix	transpose() Returns the transpose of this matrix.

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

add, extractSubSymmetricMatrix, scalarAdd, scalarMultiply, subtract

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

positiveScalarMultiply

SymmetricPositiveMatrix positiveScalarMultiply(double d)

Multiplies each entry of this matrix by a positive scalar.

Parameters:

d - the scalar by which each entry is multiplied

Returns:

the matrix resulting from this multiplication

positiveScalarAdd

SymmetricPositiveMatrix positiveScalarAdd(double d)

Adds a positive scalar to each entry of this matrix.

Parameters:

d - the scalar to add to each entry

Returns:

the matrix resulting from this addition

add

SymmetricPositiveMatrix add(SymmetricPositiveMatrix m)

Adds a SymmetricPositiveMatrix to this matrix.

Parameters:

m - the matrix to add

Returns:

the matrix resulting from this addition

copy

SymmetricPositiveMatrix copy()

Returns a (deep) copy of this.

Specified by:

copy in interface RealMatrix

Specified by:

copy in interface SymmetricMatrix

Returns:

matrix copy

quadraticMultiplication

SymmetricPositiveMatrix 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.

Specified by:

quadraticMultiplication in interface SymmetricMatrix

Parameters:

m - the matrix M

Returns:

M×S×M^T

quadraticMultiplication

SymmetricPositiveMatrix 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.

Specified by:

quadraticMultiplication in interface SymmetricMatrix

Parameters:

m - the matrix M or the matrix M^T

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

Returns:

M×S×M^T

transpose

SymmetricPositiveMatrix transpose()

Returns the transpose of this matrix.

Specified by:

transpose in interface RealMatrix

Specified by:

transpose in interface SymmetricMatrix

Returns:

transpose matrix

power

SymmetricPositiveMatrix 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

Specified by:

power in interface SymmetricMatrix

Parameters:

p - raise this to power p

Returns:

this^p

getInverse

SymmetricPositiveMatrix 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

Specified by:

getInverse in interface SymmetricMatrix

Returns:

inverse matrix

getInverse

SymmetricPositiveMatrix 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

Specified by:

getInverse in interface SymmetricMatrix

Parameters:

decompositionBuilder - decomposition function to use

Returns:

inverse matrix