Package no.uib.cipr.matrix
Class UpperSPDDenseMatrix
java.lang.Object
no.uib.cipr.matrix.AbstractMatrix
no.uib.cipr.matrix.UpperSymmDenseMatrix
no.uib.cipr.matrix.UpperSPDDenseMatrix
- All Implemented Interfaces:
Iterable<MatrixEntry>
,Matrix
Upper symmetrical positive definite dense matrix. Same layout as
UpperSymmDenseMatrix
. This
class does not enforce the SPD property, but serves as a tag so that more
efficient algorithms can be used in the solvers.-
Nested Class Summary
Nested classes/interfaces inherited from interface no.uib.cipr.matrix.Matrix
Matrix.Norm
-
Field Summary
Fields inherited from class no.uib.cipr.matrix.AbstractMatrix
numColumns, numRows
-
Constructor Summary
ConstructorsConstructorDescriptionUpperSPDDenseMatrix
(int n) Constructor for UpperSPDDenseMatrixConstructor for UpperSPDDenseMatrixUpperSPDDenseMatrix
(Matrix A, boolean deep) Constructor for UpperSPDDenseMatrix -
Method Summary
Modifier and TypeMethodDescriptioncopy()
Creates a deep copy of the matrixdouble[]
getData()
Returns the matrix contents.C = alpha*A*B + C
y = alpha*A*x + y
A = alpha*C*CT + A
.A = alpha*x*yT + A
.A = alpha*B*CT + alpha*C*BT + A
.A = alpha*x*yT + alpha*y*xT + A
.A=B
.X = A\B
.x = A\b
.transAmultAdd
(double alpha, Matrix B, Matrix C) C = alpha*AT*B + C
transMultAdd
(double alpha, Vector x, Vector y) y = alpha*AT*x + y
Transposes the matrix in-place.transRank1
(double alpha, Matrix C) A = alpha*CT*C + A
The matrices must be square and of the same sizetransRank2
(double alpha, Matrix B, Matrix C) A = alpha*BT*C + alpha*CT*B + A
.transSolve
(Matrix B, Matrix X) X = AT\B
.transSolve
(Vector b, Vector x) x = AT\b
.zero()
Zeros all the entries in the matrix, while preserving any underlying structure.Methods inherited from class no.uib.cipr.matrix.UpperSymmDenseMatrix
add, get, set
Methods inherited from class no.uib.cipr.matrix.AbstractMatrix
add, add, check, checkMultAdd, checkMultAdd, checkRank1, checkRank1, checkRank2, checkRank2, checkSize, checkSolve, checkSolve, checkTransABmultAdd, checkTransAmultAdd, checkTransBmultAdd, checkTransMultAdd, checkTranspose, checkTranspose, checkTransRank1, checkTransRank2, isSquare, iterator, max, max, mult, mult, mult, mult, multAdd, multAdd, norm, norm1, normF, normInf, numColumns, numRows, rank1, rank1, rank1, rank1, rank2, rank2, scale, set, toString, transABmult, transABmult, transABmultAdd, transABmultAdd, transAmult, transAmult, transAmultAdd, transBmult, transBmult, transBmultAdd, transBmultAdd, transMult, transMult, transMultAdd, transpose, transRank1, transRank2
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
UpperSPDDenseMatrix
public UpperSPDDenseMatrix(int n) Constructor for UpperSPDDenseMatrix- Parameters:
n
- Size of the matrix. Since the matrix must be square, this equals both the number of rows and columns
-
UpperSPDDenseMatrix
Constructor for UpperSPDDenseMatrix- Parameters:
A
- Matrix to copy. It must be a square matrix, and only the upper triangular part is copied
-
UpperSPDDenseMatrix
Constructor for UpperSPDDenseMatrix- Parameters:
A
- Matrix to copy. It must be a square matrix, and only the upper triangular part is copieddeep
- True for a deep copy, else shallow. In that case,A
must be a dense matrix
-
-
Method Details
-
copy
Description copied from interface:Matrix
Creates a deep copy of the matrix- Specified by:
copy
in interfaceMatrix
- Overrides:
copy
in classUpperSymmDenseMatrix
- Returns:
- A
-
solve
Description copied from interface:Matrix
X = A\B
. Not all matrices support this operation, those that do not throwUnsupportedOperationException
. Note that it is often more efficient to use a matrix decomposition and its associated solver -
multAdd
Description copied from interface:Matrix
C = alpha*A*B + C
- Specified by:
multAdd
in interfaceMatrix
- Overrides:
multAdd
in classAbstractMatrix
- Parameters:
B
- Matrix such thatB.numRows() == A.numColumns()
andB.numColumns() == C.numColumns()
C
- Matrix such thatC.numRows() == A.numRows()
andB.numColumns() == C.numColumns()
- Returns:
- C
-
transAmultAdd
Description copied from interface:Matrix
C = alpha*AT*B + C
- Specified by:
transAmultAdd
in interfaceMatrix
- Overrides:
transAmultAdd
in classAbstractMatrix
- Parameters:
B
- Matrix such thatB.numRows() == A.numRows()
andB.numColumns() == C.numColumns()
C
- Matrix such thatC.numRows() == A.numColumns()
andB.numColumns() == C.numColumns()
- Returns:
- C
-
rank1
Description copied from interface:Matrix
A = alpha*x*yT + A
. The matrix must be square, and the vectors of the same length- Specified by:
rank1
in interfaceMatrix
- Overrides:
rank1
in classAbstractMatrix
- Returns:
- A
-
rank2
Description copied from interface:Matrix
A = alpha*x*yT + alpha*y*xT + A
. The matrix must be square, and the vectors of the same length- Specified by:
rank2
in interfaceMatrix
- Overrides:
rank2
in classAbstractMatrix
- Returns:
- A
-
multAdd
Description copied from interface:Matrix
y = alpha*A*x + y
- Specified by:
multAdd
in interfaceMatrix
- Overrides:
multAdd
in classAbstractMatrix
- Parameters:
x
- Vector of sizeA.numColumns()
y
- Vector of sizeA.numRows()
- Returns:
- y
-
transMultAdd
Description copied from interface:Matrix
y = alpha*AT*x + y
- Specified by:
transMultAdd
in interfaceMatrix
- Overrides:
transMultAdd
in classAbstractMatrix
- Parameters:
x
- Vector of sizeA.numRows()
y
- Vector of sizeA.numColumns()
- Returns:
- y
-
rank1
Description copied from interface:Matrix
A = alpha*C*CT + A
. The matrices must be square and of the same size- Specified by:
rank1
in interfaceMatrix
- Overrides:
rank1
in classAbstractMatrix
- Returns:
- A
-
transRank1
Description copied from interface:Matrix
A = alpha*CT*C + A
The matrices must be square and of the same size- Specified by:
transRank1
in interfaceMatrix
- Overrides:
transRank1
in classAbstractMatrix
- Returns:
- A
-
rank2
Description copied from interface:Matrix
A = alpha*B*CT + alpha*C*BT + A
. This matrix must be square- Specified by:
rank2
in interfaceMatrix
- Overrides:
rank2
in classAbstractMatrix
- Parameters:
B
- Matrix with the same number of rows asA
and the same number of columns asC
C
- Matrix with the same number of rows asA
and the same number of columns asB
- Returns:
- A
-
transRank2
Description copied from interface:Matrix
A = alpha*BT*C + alpha*CT*B + A
. This matrix must be square- Specified by:
transRank2
in interfaceMatrix
- Overrides:
transRank2
in classAbstractMatrix
- Parameters:
B
- Matrix with the same number of rows asC
and the same number of columns asA
C
- Matrix with the same number of rows asB
and the same number of columns asA
- Returns:
- A
-
solve
Description copied from interface:Matrix
x = A\b
. Not all matrices support this operation, those that do not throwUnsupportedOperationException
. Note that it is often more efficient to use a matrix decomposition and its associated solver- Specified by:
solve
in interfaceMatrix
- Overrides:
solve
in classAbstractMatrix
- Parameters:
b
- Vector of sizeA.numRows()
x
- Vector of sizeA.numColumns()
- Returns:
- x
-
transSolve
Description copied from interface:Matrix
X = AT\B
. Not all matrices support this operation, those that do not throwUnsupportedOperationException
. Note that it is often more efficient to use a matrix decomposition and its associated transpose solver- Specified by:
transSolve
in interfaceMatrix
- Overrides:
transSolve
in classAbstractMatrix
- Parameters:
B
- Matrix with a number of rows equalA.numColumns()
, and the same number of columns asX
X
- Matrix with the same number of rows asA
, and the same number of columns asB
- Returns:
- X
-
transSolve
Description copied from interface:Matrix
x = AT\b
. Not all matrices support this operation, those that do not throwUnsupportedOperationException
. Note that it is often more efficient to use a matrix decomposition and its associated solver- Specified by:
transSolve
in interfaceMatrix
- Overrides:
transSolve
in classAbstractMatrix
- Parameters:
b
- Vector of sizeA.numColumns()
x
- Vector of sizeA.numRows()
- Returns:
- x
-
transpose
Description copied from interface:Matrix
Transposes the matrix in-place. In most cases, the matrix must be square for this to work.- Specified by:
transpose
in interfaceMatrix
- Overrides:
transpose
in classAbstractMatrix
- Returns:
- This matrix
-
getData
public double[] getData()Returns the matrix contents. Ordering depends on the underlying storage assumptions -
set
Description copied from interface:Matrix
A=B
. The matrices must be of the same size- Specified by:
set
in interfaceMatrix
- Overrides:
set
in classAbstractMatrix
- Returns:
- A
-
zero
Description copied from interface:Matrix
Zeros all the entries in the matrix, while preserving any underlying structure. Useful for general, unstructured matrices.- Specified by:
zero
in interfaceMatrix
- Overrides:
zero
in classAbstractMatrix
- Returns:
- A
-