Class SparseFieldMatrix<T extends FieldElement<T>>
- java.lang.Object
-
- org.apache.commons.math4.legacy.linear.AbstractFieldMatrix<T>
-
- org.apache.commons.math4.legacy.linear.SparseFieldMatrix<T>
-
- Type Parameters:
T- the type of the field elements
- All Implemented Interfaces:
AnyMatrix,FieldMatrix<T>
public class SparseFieldMatrix<T extends FieldElement<T>> extends AbstractFieldMatrix<T>
Sparse matrix implementation based on an open addressed map.Caveat: This implementation assumes that, for any
x, the equalityx * 0d == 0dholds. But it is is not true forNaN. Moreover, zero entries will lose their sign. Some operations (that involveNaNand/or infinities) may thus give incorrect results.- Since:
- 2.0
-
-
Constructor Summary
Constructors Constructor Description SparseFieldMatrix(Field<T> field)Create a matrix with no data.SparseFieldMatrix(Field<T> field, int rowDimension, int columnDimension)Create a newSparseFieldMatrix<T>with the supplied row and column dimensions.SparseFieldMatrix(FieldMatrix<T> other)Generic copy constructor.SparseFieldMatrix(SparseFieldMatrix<T> other)Copy constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddToEntry(int row, int column, T increment)Change an entry in the specified row and column.FieldMatrix<T>copy()Make a (deep) copy of this.FieldMatrix<T>createMatrix(int rowDimension, int columnDimension)Create a newFieldMatrix<T>of the same type as the instance with the supplied row and column dimensions.intgetColumnDimension()Gets the number of columns.TgetEntry(int row, int column)Returns the entry in the specified row and column.intgetRowDimension()Gets the number of rows.voidmultiplyEntry(int row, int column, T factor)Change an entry in the specified row and column.voidsetEntry(int row, int column, T value)Set the entry in the specified row and column.-
Methods inherited from class org.apache.commons.math4.legacy.linear.AbstractFieldMatrix
add, checkColumnIndex, checkRowIndex, checkSubMatrixIndex, checkSubMatrixIndex, copySubMatrix, copySubMatrix, equals, extractField, extractField, getColumn, getColumnMatrix, getColumnVector, getData, getField, getRow, getRowMatrix, getRowVector, getSubMatrix, getSubMatrix, getTrace, hashCode, multiply, operate, operate, power, preMultiply, preMultiply, preMultiply, scalarAdd, scalarMultiply, setColumn, setColumnMatrix, setColumnVector, setRow, setRowMatrix, setRowVector, setSubMatrix, subtract, toString, transpose, walkInColumnOrder, walkInColumnOrder, walkInColumnOrder, walkInColumnOrder, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder, walkInRowOrder, walkInRowOrder, walkInRowOrder, walkInRowOrder
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.commons.math4.legacy.linear.AnyMatrix
canAdd, canMultiply, checkAdd, checkMultiply, isSquare
-
-
-
-
Constructor Detail
-
SparseFieldMatrix
public SparseFieldMatrix(Field<T> field)
Create a matrix with no data.- Parameters:
field- Field to which the elements belong.
-
SparseFieldMatrix
public SparseFieldMatrix(Field<T> field, int rowDimension, int columnDimension)
Create a newSparseFieldMatrix<T>with the supplied row and column dimensions.- Parameters:
field- Field to which the elements belong.rowDimension- Number of rows in the new matrix.columnDimension- Number of columns in the new matrix.- Throws:
NotStrictlyPositiveException- if row or column dimension is not positive.
-
SparseFieldMatrix
public SparseFieldMatrix(SparseFieldMatrix<T> other)
Copy constructor.- Parameters:
other- Instance to copy.
-
SparseFieldMatrix
public SparseFieldMatrix(FieldMatrix<T> other)
Generic copy constructor.- Parameters:
other- Instance to copy.
-
-
Method Detail
-
addToEntry
public void addToEntry(int row, int column, T increment)
Change an entry in the specified row and column.- Specified by:
addToEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
addToEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row location of entry to be set.column- Column location of entry to be set.increment- Value to add to the current matrix entry in(row, column).
-
copy
public FieldMatrix<T> copy()
Make a (deep) copy of this.- Specified by:
copyin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
copyin classAbstractFieldMatrix<T extends FieldElement<T>>- Returns:
- a copy of this matrix.
-
createMatrix
public FieldMatrix<T> createMatrix(int rowDimension, int columnDimension)
Create a newFieldMatrix<T>of the same type as the instance with the supplied row and column dimensions.- Specified by:
createMatrixin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
createMatrixin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
rowDimension- the number of rows in the new matrixcolumnDimension- the number of columns in the new matrix- Returns:
- a new matrix of the same type as the instance
-
getColumnDimension
public int getColumnDimension()
Gets the number of columns.- Returns:
- the number of columns.
-
getEntry
public T getEntry(int row, int column)
Returns the entry in the specified row and column.- Specified by:
getEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
getEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- row location of entry to be fetchedcolumn- column location of entry to be fetched- Returns:
- matrix entry in row,column
-
getRowDimension
public int getRowDimension()
Gets the number of rows.- Returns:
- the number of rows.
-
multiplyEntry
public void multiplyEntry(int row, int column, T factor)
Change an entry in the specified row and column.- Specified by:
multiplyEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
multiplyEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- Row location of entry to be set.column- Column location of entry to be set.factor- Multiplication factor for the current matrix entry in(row,column)
-
setEntry
public void setEntry(int row, int column, T value)
Set the entry in the specified row and column.- Specified by:
setEntryin interfaceFieldMatrix<T extends FieldElement<T>>- Specified by:
setEntryin classAbstractFieldMatrix<T extends FieldElement<T>>- Parameters:
row- row location of entry to be setcolumn- column location of entry to be setvalue- matrix entry to be set in row,column
-
-