Class UpperTriangularMatrix
- java.lang.Object
-
- dev.nm.algebra.linear.matrix.doubles.matrixtype.dense.triangle.UpperTriangularMatrix
-
- All Implemented Interfaces:
Matrix,MatrixAccess,MatrixRing,MatrixTable,Densifiable,AbelianGroup<Matrix>,Monoid<Matrix>,Ring<Matrix>,Table,DeepCopyable
public class UpperTriangularMatrix extends Object implements Matrix, Densifiable
An upper triangular matrix has 0 entries where row index is greater than column index. An upper triangular matrix is always square.
-
-
Constructor Summary
Constructors Constructor Description UpperTriangularMatrix(double[][] data)Constructs an upper triangular matrix from a 2Ddouble[][]array.UpperTriangularMatrix(int dim)Constructs an upper triangular matrix of dimension dim * dim.UpperTriangularMatrix(Matrix A)Constructs an upper triangular matrix from a matrix.UpperTriangularMatrix(UpperTriangularMatrix U)Copy constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Matrixadd(Matrix that)this + thatUpperTriangularMatrixdeepCopy()The implementation returns an instance created fromthisby the copy constructor of the class, or justthisif the instance itself is immutable.booleanequals(Object obj)doubleget(int i, int j)Get the matrix entry at [i,j].VectorgetColumn(int j)Get the specified column in the matrix as a vector.VectorgetRow(int i)Get the specified row in the matrix as a vector.inthashCode()Matrixminus(Matrix that)this - thatMatrixmultiply(Matrix that)this * thatVectormultiply(Vector v)Right multiply this matrix, A, by a vector.intnCols()Gets the number of columns.intnRows()Gets the number of rows.UpperTriangularMatrixONE()Get an identity matrix that has the same dimension as this matrix.UpperTriangularMatrixopposite()Get the opposite of this matrix.UpperTriangularMatrixscaled(double scalar)Scale this matrix, A, by a constant.voidset(int i, int j, double value)Set the matrix entry at [i,j] to a value.LowerTriangularMatrixt()Get the transpose of this matrix.DenseMatrixtoDense()Densify a matrix, i.e., convert a matrix implementation to the standard dense matrix,DenseMatrix.StringtoString()UpperTriangularMatrixZERO()Get a zero matrix that has the same dimension as this matrix.
-
-
-
Constructor Detail
-
UpperTriangularMatrix
public UpperTriangularMatrix(int dim)
Constructs an upper triangular matrix of dimension dim * dim.- Parameters:
dim- the matrix dimension
-
UpperTriangularMatrix
public UpperTriangularMatrix(double[][] data)
Constructs an upper triangular matrix from a 2Ddouble[][]array.- Parameters:
data- the 2D array input- Throws:
IllegalArgumentException- when the inputdatais not a upper triangular
-
UpperTriangularMatrix
public UpperTriangularMatrix(Matrix A)
Constructs an upper triangular matrix from a matrix.- Parameters:
A- a matrix- Throws:
IllegalArgumentException- whenAis not square
-
UpperTriangularMatrix
public UpperTriangularMatrix(UpperTriangularMatrix U)
Copy constructor.- Parameters:
U- an upper triangular matrix
-
-
Method Detail
-
deepCopy
public UpperTriangularMatrix deepCopy()
Description copied from interface:DeepCopyableThe implementation returns an instance created fromthisby the copy constructor of the class, or justthisif the instance itself is immutable.- Specified by:
deepCopyin interfaceDeepCopyable- Specified by:
deepCopyin interfaceMatrix- Returns:
- an independent (deep) copy of the instance
-
toDense
public DenseMatrix toDense()
Description copied from interface:DensifiableDensify a matrix, i.e., convert a matrix implementation to the standard dense matrix,DenseMatrix.- Specified by:
toDensein interfaceDensifiable- Returns:
- a matrix representation in
DenseMatrix
-
nRows
public int nRows()
Description copied from interface:TableGets the number of rows. Rows count from 1.
-
nCols
public int nCols()
Description copied from interface:TableGets the number of columns. Columns count from 1.
-
set
public void set(int i, int j, double value) throws MatrixAccessExceptionDescription copied from interface:MatrixAccessSet the matrix entry at [i,j] to a value. This is the only method that may change a matrix.- Specified by:
setin interfaceMatrixAccess- Parameters:
i- the row indexj- the column indexvalue- the value to set A[i,j] to- Throws:
MatrixAccessException- if i or j is out of range
-
get
public double get(int i, int j) throws MatrixAccessExceptionDescription copied from interface:MatrixAccessGet the matrix entry at [i,j].- Specified by:
getin interfaceMatrixAccess- Parameters:
i- the row indexj- the column index- Returns:
- A[i,j]
- Throws:
MatrixAccessException- if i or j is out of range
-
getRow
public Vector getRow(int i)
Description copied from interface:MatrixGet the specified row in the matrix as a vector.
-
getColumn
public Vector getColumn(int j)
Description copied from interface:MatrixGet the specified column in the matrix as a vector.
-
add
public Matrix add(Matrix that)
Description copied from interface:MatrixRingthis + that- Specified by:
addin interfaceAbelianGroup<Matrix>- Specified by:
addin interfaceMatrixRing- Parameters:
that- a matrix- Returns:
- the sum of
thisandthat
-
minus
public Matrix minus(Matrix that)
Description copied from interface:MatrixRingthis - that- Specified by:
minusin interfaceAbelianGroup<Matrix>- Specified by:
minusin interfaceMatrixRing- Parameters:
that- a matrix- Returns:
- the difference between
thisandthat
-
multiply
public Matrix multiply(Matrix that)
Description copied from interface:MatrixRingthis * that- Specified by:
multiplyin interfaceMatrixRing- Specified by:
multiplyin interfaceMonoid<Matrix>- Parameters:
that- a matrix- Returns:
- the product of
thisandthat
-
t
public LowerTriangularMatrix t()
Description copied from interface:MatrixRingGet the transpose of this matrix. This is the involution on the matrix ring.- Specified by:
tin interfaceMatrixRing- Returns:
- the transpose of this matrix
-
scaled
public UpperTriangularMatrix scaled(double scalar)
Description copied from interface:MatrixScale this matrix, A, by a constant.
-
opposite
public UpperTriangularMatrix opposite()
Description copied from interface:MatrixRingGet the opposite of this matrix.- Specified by:
oppositein interfaceAbelianGroup<Matrix>- Specified by:
oppositein interfaceMatrixRing- Returns:
- -this
- See Also:
- Wikipedia: Additive inverse
-
multiply
public Vector multiply(Vector v)
Description copied from interface:MatrixRight multiply this matrix, A, by a vector.
-
ZERO
public UpperTriangularMatrix ZERO()
Description copied from interface:MatrixRingGet a zero matrix that has the same dimension as this matrix.- Specified by:
ZEROin interfaceAbelianGroup<Matrix>- Specified by:
ZEROin interfaceMatrixRing- Returns:
- the 0 matrix
-
ONE
public UpperTriangularMatrix ONE()
Description copied from interface:MatrixRingGet an identity matrix that has the same dimension as this matrix. For a non-square matrix, it zeros out the rows (columns) with index > nCols (nRows).- Specified by:
ONEin interfaceMatrixRing- Specified by:
ONEin interfaceMonoid<Matrix>- Returns:
- an identity matrix
-
-