Package no.uib.cipr.matrix
Class UnitUpperTriangBandMatrix
- java.lang.Object
-
- no.uib.cipr.matrix.AbstractMatrix
-
- no.uib.cipr.matrix.UpperTriangBandMatrix
-
- no.uib.cipr.matrix.UnitUpperTriangBandMatrix
-
- All Implemented Interfaces:
java.lang.Iterable<MatrixEntry>
,Matrix
public class UnitUpperTriangBandMatrix extends UpperTriangBandMatrix
Unit upper triangular banded matrix. The same storage asLowerTriangBandMatrix
, 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
Constructors Constructor Description UnitUpperTriangBandMatrix(int n, int kd)
Constructor for UnitUpperTriangBandMatrixUnitUpperTriangBandMatrix(Matrix A, int kd)
Constructor for UnitUpperTriangBandMatrixUnitUpperTriangBandMatrix(Matrix A, int kd, boolean deep)
Constructor for UnitUpperTriangBandMatrix
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(int row, int column, double value)
A(row,column) += value
UnitUpperTriangBandMatrix
copy()
Creates a deep copy of the matrixdouble
get(int row, int column)
ReturnsA(row,column)
double[]
getData()
Returns the matrix contentsjava.util.Iterator<MatrixEntry>
iterator()
Vector
mult(double alpha, Vector x, Vector y)
y = alpha*A*x
int
numSubDiagonals()
Returns the number of lower diagonalsint
numSuperDiagonals()
Returns the number of upper diagonalsvoid
set(int row, int column, double value)
A(row,column) = value
Matrix
set(Matrix B)
A=B
.Matrix
solve(Matrix B, Matrix X)
X = A\B
.Vector
solve(Vector b, Vector x)
x = A\b
.Vector
transMult(double alpha, Vector x, Vector y)
y = alpha*AT*x
Matrix
transSolve(Matrix B, Matrix X)
X = AT\B
.Vector
transSolve(Vector b, Vector x)
x = AT\b
.Matrix
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
-
-
-
-
Constructor Detail
-
UnitUpperTriangBandMatrix
public UnitUpperTriangBandMatrix(int n, int kd)
Constructor for UnitUpperTriangBandMatrix- Parameters:
n
- Size of the matrix. Since the matrix must be square, this equals both the number of rows and columnskd
- Number of bands above the main diagonal (superdiagonals)
-
UnitUpperTriangBandMatrix
public UnitUpperTriangBandMatrix(Matrix A, int kd)
Constructor for UnitUpperTriangBandMatrix- 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 above the main diagonal (superdiagonals)
-
UnitUpperTriangBandMatrix
public UnitUpperTriangBandMatrix(Matrix A, int kd, boolean deep)
Constructor for UnitUpperTriangBandMatrix- 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 above the main diagonal (superdiagonals)deep
- True for a deep copy. For shallow copies,A
must be a banded matrix
-
-
Method Detail
-
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
public UnitUpperTriangBandMatrix copy()
Description copied from interface:Matrix
Creates a deep copy of the matrix- Specified by:
copy
in interfaceMatrix
- Overrides:
copy
in classUpperTriangBandMatrix
- Returns:
- A
-
zero
public Matrix zero()
Description copied from interface:Matrix
Zeros all the entries in the matrix, while preserving any underlying structure. Useful for general, unstructured matrices.
-
mult
public Vector mult(double alpha, Vector x, Vector y)
Description copied from interface:Matrix
y = alpha*A*x
- Specified by:
mult
in interfaceMatrix
- Overrides:
mult
in classAbstractMatrix
x
- Vector of sizeA.numColumns()
y
- Vector of sizeA.numRows()
- Returns:
- y
-
transMult
public Vector transMult(double alpha, Vector x, Vector y)
Description copied from interface:Matrix
y = alpha*AT*x
- Specified by:
transMult
in interfaceMatrix
- Overrides:
transMult
in classAbstractMatrix
x
- Vector of sizeA.numRows()
y
- Vector of sizeA.numColumns()
- Returns:
- y
-
solve
public Matrix solve(Matrix B, Matrix X)
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
public Vector solve(Vector b, Vector x)
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
public Matrix transSolve(Matrix B, Matrix X)
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
public Vector transSolve(Vector b, Vector x)
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
public Matrix set(Matrix B)
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
public java.util.Iterator<MatrixEntry> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<MatrixEntry>
- Overrides:
iterator
in classAbstractMatrix
-
-