Package no.uib.cipr.matrix
Class TridiagMatrix
java.lang.Object
no.uib.cipr.matrix.AbstractMatrix
no.uib.cipr.matrix.TridiagMatrix
- All Implemented Interfaces:
Iterable<MatrixEntry>
,Matrix
Tridiagonal matrix. Stored in three arrays, one of length
n
for the diagonal, two of length n-1
for the superdiagonal and
subdiagonal entries.-
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
ConstructorsConstructorDescriptionTridiagMatrix
(int n) Constructor for TridiagMatrixConstructor for TridiagMatrixTridiagMatrix
(Matrix A, boolean deep) Constructor for TridiagMatrix -
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[]
Returns the diagonal entries.double[]
Returns the sub diagonal entries.double[]
Returns the super diagonal entries.iterator()
void
set
(int row, int column, double value) A(row,column) = value
X = A\B
.x = A\b
.Transposes the matrix in-place.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, mult, multAdd, multAdd, multAdd, multAdd, norm, norm1, normF, normInf, numColumns, numRows, rank1, rank1, rank1, rank1, rank1, rank1, rank2, rank2, rank2, rank2, scale, set, set, toString, transABmult, transABmult, transABmultAdd, transABmultAdd, transAmult, transAmult, transAmultAdd, transAmultAdd, transBmult, transBmult, transBmultAdd, transBmultAdd, transMult, transMult, transMultAdd, transMultAdd, transpose, transRank1, transRank1, transRank2, transRank2, transSolve, transSolve
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
-
TridiagMatrix
public TridiagMatrix(int n) Constructor for TridiagMatrix- Parameters:
n
- Size of the matrix. Since the matrix must be square, this equals both the number of rows and columns
-
TridiagMatrix
Constructor for TridiagMatrix- Parameters:
A
- Matrix to copy from. Only the tridiagonal part is copied
-
TridiagMatrix
Constructor for TridiagMatrix- Parameters:
A
- Matrix to copy from. Only the tridiagonal part is copieddeep
- True for a deep copy, else it's shallow. For shallow copies,A
must be aTridiagMatrix
-
-
Method Details
-
getDiagonal
public double[] getDiagonal()Returns the diagonal entries. Length equaln
-
getSubDiagonal
public double[] getSubDiagonal()Returns the sub diagonal entries. Length equaln-1
-
getSuperDiagonal
public double[] getSuperDiagonal()Returns the super diagonal entries. Length equaln-1
-
add
public void add(int row, int column, double value) Description copied from interface:Matrix
A(row,column) += value
- Specified by:
add
in interfaceMatrix
- Overrides:
add
in classAbstractMatrix
-
get
public double get(int row, int column) Description copied from interface:Matrix
ReturnsA(row,column)
- Specified by:
get
in interfaceMatrix
- Overrides:
get
in classAbstractMatrix
-
set
public void set(int row, int column, double value) Description copied from interface:Matrix
A(row,column) = value
- Specified by:
set
in interfaceMatrix
- Overrides:
set
in classAbstractMatrix
-
copy
Description copied from interface:Matrix
Creates a deep copy of the matrix- Specified by:
copy
in interfaceMatrix
- Overrides:
copy
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
-
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
-
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
-
iterator
- Specified by:
iterator
in interfaceIterable<MatrixEntry>
- Overrides:
iterator
in classAbstractMatrix
-