Class LILSparseMatrix
- java.lang.Object
-
- dev.nm.algebra.linear.matrix.doubles.matrixtype.sparse.LILSparseMatrix
-
- All Implemented Interfaces:
Matrix,MatrixAccess,MatrixRing,MatrixTable,Densifiable,SparseMatrix,SparseStructure,AbelianGroup<Matrix>,Monoid<Matrix>,Ring<Matrix>,Table,DeepCopyable
public class LILSparseMatrix extends Object implements SparseMatrix
The list of lists (LIL) format for sparse matrix stores one list per row, where each entry stores a column index and value. Typically, these entries are kept sorted by column index for faster lookup. This is another format which is good for incremental matrix construction.- See Also:
- Wikipedia: List of lists (LIL)
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface dev.nm.algebra.linear.matrix.doubles.matrixtype.sparse.SparseMatrix
SparseMatrix.Entry, SparseMatrix.ValueArray
-
-
Constructor Summary
Constructors Constructor Description LILSparseMatrix(int nRows, int nCols)Construct a sparse matrix in LIL format.LILSparseMatrix(int nRows, int nCols, int[] rowIndices, int[] columnIndices, double[] value)Construct a sparse matrix in LIL format.LILSparseMatrix(int nRows, int nCols, List<SparseMatrix.Entry> entries)Construct a sparse matrix in LIL format by a list of non-zero entries.LILSparseMatrix(LILSparseMatrix that)Copy constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Matrixadd(Matrix that)this + thatLILSparseMatrixdeepCopy()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 row, int col)Get the matrix entry at [i,j].SparseVectorgetColumn(int j)Get the specified column in the matrix as a vector.List<SparseMatrix.Entry>getEntryList()Exports the non-zero values in the matrix as a list ofSparseMatrix.Entrys.SparseVectorgetRow(int i)Get the specified row in the matrix as a vector.SparseMatrix.ValueArraygetValueArray()Exports the non-zero values in the matrix as arrays of row/column indices and values.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.intnNonZeros()Get the number of non-zero entries in the structure.intnRows()Gets the number of rows.LILSparseMatrixONE()Get an identity matrix that has the same dimension as this matrix.LILSparseMatrixopposite()Get the opposite of this matrix.LILSparseMatrixscaled(double c)Scale this matrix, A, by a constant.voidset(int row, int col, double value)Set the matrix entry at [i,j] to a value.LILSparseMatrixsubMatrix(int rowFrom, int rowTo, int colFrom, int colTo)Extracts a sub-matrix given the bounds of row and column indices (inclusive).LILSparseMatrixt()Get the transpose of this matrix.DenseMatrixtoDense()Densify a matrix, i.e., convert a matrix implementation to the standard dense matrix,DenseMatrix.StringtoString()LILSparseMatrixZERO()Get a zero matrix that has the same dimension as this matrix.
-
-
-
Constructor Detail
-
LILSparseMatrix
public LILSparseMatrix(int nRows, int nCols)Construct a sparse matrix in LIL format.- Parameters:
nRows- the number of rowsnCols- the number of columns
-
LILSparseMatrix
public LILSparseMatrix(int nRows, int nCols, int[] rowIndices, int[] columnIndices, double[] value)Construct a sparse matrix in LIL format.- Parameters:
nRows- the number of rowsnCols- the number of columnsrowIndices- the row indices of the non-zeros valuescolumnIndices- the column indices of the non-zeros valuesvalue- the non-zero values
-
LILSparseMatrix
public LILSparseMatrix(int nRows, int nCols, List<SparseMatrix.Entry> entries)Construct a sparse matrix in LIL format by a list of non-zero entries.- Parameters:
nRows- the number of rowsnCols- the number of columnsentries- the list of entries
-
LILSparseMatrix
public LILSparseMatrix(LILSparseMatrix that)
Copy constructor.- Parameters:
that- the matrix to be copied
-
-
Method Detail
-
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.
-
getEntryList
public List<SparseMatrix.Entry> getEntryList()
Description copied from interface:SparseMatrixExports the non-zero values in the matrix as a list ofSparseMatrix.Entrys. This is useful for converting between the different formats ofSparseMatrix.Entry. For example,// construct matrix using DOK DOKSparseMatrix dok = new DOKSparseMatrix(5, 5); // ... insert some values to DOK matrix // convert to CSR matrix for efficient matrix operations CSRSparseMatrix csr = new CSRSparseMatrix(5, 5, dok.getEntryList());- Specified by:
getEntryListin interfaceSparseMatrix- Returns:
- the sparse entries
-
getValueArray
public SparseMatrix.ValueArray getValueArray()
Description copied from interface:SparseMatrixExports the non-zero values in the matrix as arrays of row/column indices and values.- Specified by:
getValueArrayin interfaceSparseMatrix- Returns:
- the arrays of indices and values
- See Also:
SparseMatrix.ValueArray
-
subMatrix
public LILSparseMatrix subMatrix(int rowFrom, int rowTo, int colFrom, int colTo)
Description copied from interface:SparseMatrixExtracts a sub-matrix given the bounds of row and column indices (inclusive).- Specified by:
subMatrixin interfaceSparseMatrix- Parameters:
rowFrom- the beginning row indexrowTo- the ending row indexcolFrom- the beginning column indexcolTo- the ending column index- Returns:
- A[rowFrom:rowTo, colFrom:colTo]
-
get
public double get(int row, int col)Description copied from interface:MatrixAccessGet the matrix entry at [i,j].- Specified by:
getin interfaceMatrixAccess- Parameters:
row- the row indexcol- the column index- Returns:
- A[i,j]
-
set
public void set(int row, int col, double value)Description 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:
row- the row indexcol- the column indexvalue- the value to set A[i,j] to
-
getRow
public SparseVector getRow(int i)
Description copied from interface:MatrixGet the specified row in the matrix as a vector.
-
getColumn
public SparseVector 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
-
multiply
public Vector multiply(Vector v)
Description copied from interface:MatrixRight multiply this matrix, A, by a vector.
-
scaled
public LILSparseMatrix scaled(double c)
Description copied from interface:MatrixScale this matrix, A, by a constant.
-
opposite
public LILSparseMatrix 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
-
t
public LILSparseMatrix 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
-
ZERO
public LILSparseMatrix 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 LILSparseMatrix 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
-
deepCopy
public LILSparseMatrix 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
-
nNonZeros
public int nNonZeros()
Description copied from interface:SparseStructureGet the number of non-zero entries in the structure.- Specified by:
nNonZerosin interfaceSparseStructure- Returns:
- the number of non-zero entries in the structure
-
-