Package org.apache.commons.math3.linear
Class SparseFieldMatrix<T extends FieldElement<T>>
java.lang.Object
org.apache.commons.math3.linear.AbstractFieldMatrix<T>
org.apache.commons.math3.linear.SparseFieldMatrix<T>
- Type Parameters:
T
- the type of the field elements
- All Implemented Interfaces:
AnyMatrix
,FieldMatrix<T>
Sparse matrix implementation based on an open addressed map.
Caveat: This implementation assumes that, for any x
,
the equality x * 0d == 0d
holds. But it is is not true for
NaN
. Moreover, zero entries will lose their sign.
Some operations (that involve NaN
and/or infinities) may
thus give incorrect results.
- Since:
- 2.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
Column dimension.private final OpenIntToFieldHashMap
<T> Storage for (sparse) matrix elements.private final int
Row dimension. -
Constructor Summary
ConstructorsConstructorDescriptionSparseFieldMatrix
(Field<T> field) Create a matrix with no data.SparseFieldMatrix
(Field<T> field, int rowDimension, int columnDimension) Create a new SparseFieldMatrixwith the supplied row and column dimensions. SparseFieldMatrix
(FieldMatrix<T> other) Generic copy constructor.SparseFieldMatrix
(SparseFieldMatrix<T> other) Copy constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addToEntry
(int row, int column, T increment) Change an entry in the specified row and column.private int
computeKey
(int row, int column) Compute the key to access a matrix element.copy()
Make a (deep) copy of this.createMatrix
(int rowDimension, int columnDimension) Create a new FieldMatrixof the same type as the instance with the supplied row and column dimensions. int
Returns the number of columns in the matrix.getEntry
(int row, int column) Returns the entry in the specified row and column.int
Returns the number of rows in the matrix.void
multiplyEntry
(int row, int column, T factor) Change an entry in the specified row and column.void
Set the entry in the specified row and column.Methods inherited from class org.apache.commons.math3.linear.AbstractFieldMatrix
add, buildArray, buildArray, checkAdditionCompatible, checkColumnIndex, checkMultiplicationCompatible, checkRowIndex, checkSubMatrixIndex, checkSubMatrixIndex, checkSubtractionCompatible, copySubMatrix, copySubMatrix, equals, extractField, extractField, getColumn, getColumnMatrix, getColumnVector, getData, getField, getRow, getRowMatrix, getRowVector, getSubMatrix, getSubMatrix, getTrace, hashCode, isSquare, 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
-
Field Details
-
entries
Storage for (sparse) matrix elements. -
rows
private final int rowsRow dimension. -
columns
private final int columnsColumn dimension.
-
-
Constructor Details
-
SparseFieldMatrix
Create a matrix with no data.- Parameters:
field
- Field to which the elements belong.
-
SparseFieldMatrix
Create a new SparseFieldMatrixwith 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
Copy constructor.- Parameters:
other
- Instance to copy.
-
SparseFieldMatrix
Generic copy constructor.- Parameters:
other
- Instance to copy.
-
-
Method Details
-
addToEntry
Change an entry in the specified row and column.- Specified by:
addToEntry
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
addToEntry
in 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
Make a (deep) copy of this.- Specified by:
copy
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
copy
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Returns:
- a copy of this matrix.
-
createMatrix
Create a new FieldMatrixof the same type as the instance with the supplied row and column dimensions. - Specified by:
createMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
createMatrix
in 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()Returns the number of columns in the matrix.- Specified by:
getColumnDimension
in interfaceAnyMatrix
- Specified by:
getColumnDimension
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Returns:
- columnDimension
-
getEntry
Returns the entry in the specified row and column.- Specified by:
getEntry
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
getEntry
in 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()Returns the number of rows in the matrix.- Specified by:
getRowDimension
in interfaceAnyMatrix
- Specified by:
getRowDimension
in classAbstractFieldMatrix<T extends FieldElement<T>>
- Returns:
- rowDimension
-
multiplyEntry
Change an entry in the specified row and column.- Specified by:
multiplyEntry
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
multiplyEntry
in 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
Set the entry in the specified row and column.- Specified by:
setEntry
in interfaceFieldMatrix<T extends FieldElement<T>>
- Specified by:
setEntry
in 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
-
computeKey
private int computeKey(int row, int column) Compute the key to access a matrix element.- Parameters:
row
- Row index of the matrix element.column
- Column index of the matrix element.- Returns:
- the key within the map to access the matrix element.
-