Package no.uib.cipr.matrix
Class LowerSPDBandMatrix
java.lang.Object
no.uib.cipr.matrix.AbstractMatrix
no.uib.cipr.matrix.LowerSymmBandMatrix
no.uib.cipr.matrix.LowerSPDBandMatrix
- All Implemented Interfaces:
Iterable<MatrixEntry>
,Matrix
Lower symmetrical positive definite banded matrix. It does not enforce this
property (except for symmetry), and has the same storage layout as
LowerSymmBandMatrix
.-
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
ConstructorsConstructorDescriptionLowerSPDBandMatrix
(int n, int kd) Constructor for LowerSPDBandMatrixLowerSPDBandMatrix
(Matrix A, int kd) Constructor for LowerSPDBandMatrixLowerSPDBandMatrix
(Matrix A, int kd, boolean deep) Constructor for LowerSPDBandMatrix -
Method Summary
Modifier and TypeMethodDescriptioncopy()
Creates a deep copy of the matrixdouble[]
getData()
Returns the matrix contentsiterator()
y = alpha*A*x + y
int
Returns the number of lower diagonalsint
Returns the number of upper diagonalsA=B
.X = A\B
.x = A\b
.transMultAdd
(double alpha, Vector x, Vector y) y = alpha*AT*x + y
Transposes the matrix in-place.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.LowerSymmBandMatrix
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, max, max, mult, mult, mult, mult, multAdd, multAdd, multAdd, norm, norm1, normF, normInf, numColumns, numRows, rank1, rank1, rank1, rank1, rank1, rank1, rank2, rank2, rank2, rank2, scale, set, toString, transABmult, transABmult, transABmultAdd, transABmultAdd, transAmult, transAmult, transAmultAdd, transAmultAdd, transBmult, transBmult, transBmultAdd, transBmultAdd, transMult, transMult, transMultAdd, transpose, transRank1, transRank1, transRank2, 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
-
LowerSPDBandMatrix
public LowerSPDBandMatrix(int n, int kd) Constructor for LowerSPDBandMatrix- Parameters:
n
- Size of the matrix. Since the matrix must be square, this equals both the number of rows and columnskd
- Number of bands off the main diagonal (off diagonals)
-
LowerSPDBandMatrix
Constructor for LowerSPDBandMatrix- Parameters:
A
- Matrix to copy contents from. Only the parts ofA
that lie within the allocated band are copied over, the rest is ignoredkd
- Number of bands off the main diagonal (off diagonals)
-
LowerSPDBandMatrix
Constructor for LowerSPDBandMatrix- Parameters:
A
- Matrix to copy contents from. Only the parts ofA
that lie within the allocated band are copied over, the rest is ignoredkd
- Number of bands off the main diagonal (off diagonals)deep
- True for a deep copy. For shallow copies,A
must be a banded matrix
-
-
Method Details
-
copy
Description copied from interface:Matrix
Creates a deep copy of the matrix- Specified by:
copy
in interfaceMatrix
- Overrides:
copy
in classLowerSymmBandMatrix
- 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
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
-
iterator
- Specified by:
iterator
in interfaceIterable<MatrixEntry>
-
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 -
numSubDiagonals
public int numSubDiagonals()Returns the number of lower diagonals -
numSuperDiagonals
public int numSuperDiagonals()Returns the number of upper diagonals -
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
-