Package no.uib.cipr.matrix
Class UnitLowerTriangBandMatrix
java.lang.Object
no.uib.cipr.matrix.AbstractMatrix
no.uib.cipr.matrix.LowerTriangBandMatrix
no.uib.cipr.matrix.UnitLowerTriangBandMatrix
- All Implemented Interfaces:
Iterable<MatrixEntry>
,Matrix
Unit lower triangular banded matrix. The same storage as
LowerTriangBandMatrix
, but
the main diagonal is assumed to be all ones. It is still allocated, however.-
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
ConstructorsConstructorDescriptionUnitLowerTriangBandMatrix
(int n, int kd) Constructor for UnitLowerTriangBandMatrixUnitLowerTriangBandMatrix
(Matrix A, int kd) Constructor for UnitLowerTriangBandMatrixUnitLowerTriangBandMatrix
(Matrix A, int kd, boolean deep) Constructor for UnitLowerTriangBandMatrix -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(int row, int column, double value) A(row,column) += value
copy()
Creates a deep copy of the matrixdouble
get
(int row, int column) ReturnsA(row,column)
double[]
getData()
Returns the matrix contentsiterator()
y = alpha*A*x
int
Returns the number of lower diagonalsint
Returns the number of upper diagonalsvoid
set
(int row, int column, double value) A(row,column) = value
A=B
.X = A\B
.x = A\b
.y = alpha*AT*x
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.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, multAdd, 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, transMultAdd, transMultAdd, transpose, 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
-
UnitLowerTriangBandMatrix
public UnitLowerTriangBandMatrix(int n, int kd) Constructor for UnitLowerTriangBandMatrix- Parameters:
n
- Size of the matrix. Since the matrix must be square, this equals both the number of rows and columnskd
- Number of bands below the main diagonal (subdiagonals)
-
UnitLowerTriangBandMatrix
Constructor for UnitLowerTriangBandMatrix- Parameters:
A
- Matrix to copy contents from. Only the parts ofA
that lie within the allocated band are copied over, the rest is ignored (including main diagonal entries)kd
- Number of bands below the main diagonal (subdiagonals)
-
UnitLowerTriangBandMatrix
Constructor for UnitLowerTriangBandMatrix- Parameters:
A
- Matrix to copy contents from. Only the parts ofA
that lie within the allocated band are copied over, the rest is ignored (including main diagonal entries)kd
- Number of bands below the main diagonal (subdiagonals)deep
- True for a deep copy. For shallow copies,A
must be a banded matrix
-
-
Method Details
-
add
public void add(int row, int column, double value) Description copied from interface:Matrix
A(row,column) += value
-
get
public double get(int row, int column) Description copied from interface:Matrix
ReturnsA(row,column)
-
set
public void set(int row, int column, double value) Description copied from interface:Matrix
A(row,column) = value
-
copy
Description copied from interface:Matrix
Creates a deep copy of the matrix- Specified by:
copy
in interfaceMatrix
- Overrides:
copy
in classLowerTriangBandMatrix
- 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. -
mult
Description copied from interface:Matrix
y = alpha*A*x
- Specified by:
mult
in interfaceMatrix
- Overrides:
mult
in classAbstractMatrix
- Parameters:
x
- Vector of sizeA.numColumns()
y
- Vector of sizeA.numRows()
- Returns:
- y
-
transMult
Description copied from interface:Matrix
y = alpha*AT*x
- Specified by:
transMult
in interfaceMatrix
- Overrides:
transMult
in classAbstractMatrix
- Parameters:
x
- Vector of sizeA.numRows()
y
- Vector of sizeA.numColumns()
- Returns:
- y
-
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
- Matrix with the same number of rows asA
, and the same number of columns asX
X
- Matrix with a number of rows equalA.numColumns()
, and the same number of columns asB
- Returns:
- X
-
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
-
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
-
iterator
- Specified by:
iterator
in interfaceIterable<MatrixEntry>
- Overrides:
iterator
in classAbstractMatrix
-