org.apache.commons.math.linear
T
- the type of the field elementspublic abstract class AbstractFieldMatrix<T extends FieldElement<T>> extends Object implements FieldMatrix<T>
FieldMatrix
methods regardless of the underlying storage.
All the methods implemented here use getEntry(int, int)
to access
matrix elements. Derived class can provide faster implementations.
Modifier and Type | Field and Description |
---|---|
private Field<T> |
field
Field to which the elements belong.
|
Modifier | Constructor and Description |
---|---|
protected |
AbstractFieldMatrix()
Constructor for use with Serializable
|
protected |
AbstractFieldMatrix(Field<T> field)
Creates a matrix with no data
|
protected |
AbstractFieldMatrix(Field<T> field,
int rowDimension,
int columnDimension)
Create a new FieldMatrix
|
Modifier and Type | Method and Description |
---|---|
FieldMatrix<T> |
add(FieldMatrix<T> m)
Compute the sum of this and m.
|
abstract void |
addToEntry(int row,
int column,
T increment)
Change an entry in the specified row and column.
|
protected static <T extends FieldElement<T>> |
buildArray(Field<T> field,
int length)
Build an array of elements.
|
protected static <T extends FieldElement<T>> |
buildArray(Field<T> field,
int rows,
int columns)
Build an array of elements.
|
protected void |
checkAdditionCompatible(FieldMatrix<T> m)
Check if a matrix is addition compatible with the instance
|
protected void |
checkColumnIndex(int column)
Check if a column index is valid.
|
protected void |
checkMultiplicationCompatible(FieldMatrix<T> m)
Check if a matrix is multiplication compatible with the instance
|
protected void |
checkRowIndex(int row)
Check if a row index is valid.
|
protected void |
checkSubMatrixIndex(int[] selectedRows,
int[] selectedColumns)
Check if submatrix ranges indices are valid.
|
protected void |
checkSubMatrixIndex(int startRow,
int endRow,
int startColumn,
int endColumn)
Check if submatrix ranges indices are valid.
|
protected void |
checkSubtractionCompatible(FieldMatrix<T> m)
Check if a matrix is subtraction compatible with the instance
|
abstract FieldMatrix<T> |
copy()
Returns a (deep) copy of this.
|
void |
copySubMatrix(int[] selectedRows,
int[] selectedColumns,
T[][] destination)
Copy a submatrix.
|
void |
copySubMatrix(int startRow,
int endRow,
int startColumn,
int endColumn,
T[][] destination)
Copy a submatrix.
|
abstract FieldMatrix<T> |
createMatrix(int rowDimension,
int columnDimension)
Create a new FieldMatrix
|
boolean |
equals(Object object)
Returns true iff
object is a
FieldMatrix instance with the same dimensions as this
and all corresponding matrix entries are equal. |
protected static <T extends FieldElement<T>> |
extractField(T[] d)
Get the elements type from an array.
|
protected static <T extends FieldElement<T>> |
extractField(T[][] d)
Get the elements type from an array.
|
T[] |
getColumn(int column)
Returns the entries in column number
col as an array. |
abstract int |
getColumnDimension()
Returns the number of columns in the matrix.
|
FieldMatrix<T> |
getColumnMatrix(int column)
Returns the entries in column number
column
as a column matrix. |
FieldVector<T> |
getColumnVector(int column)
Returns the entries in column number
column
as a vector. |
T[][] |
getData()
Returns matrix entries as a two-dimensional array.
|
abstract T |
getEntry(int row,
int column)
Returns the entry in the specified row and column.
|
Field<T> |
getField()
Get the type of field elements of the matrix.
|
T[] |
getRow(int row)
Returns the entries in row number
row as an array. |
abstract int |
getRowDimension()
Returns the number of rows in the matrix.
|
FieldMatrix<T> |
getRowMatrix(int row)
Returns the entries in row number
row
as a row matrix. |
FieldVector<T> |
getRowVector(int row)
Returns the entries in row number
row
as a vector. |
FieldMatrix<T> |
getSubMatrix(int[] selectedRows,
int[] selectedColumns)
Gets a submatrix.
|
FieldMatrix<T> |
getSubMatrix(int startRow,
int endRow,
int startColumn,
int endColumn)
Gets a submatrix.
|
T |
getTrace()
Returns the
trace of the matrix (the sum of the elements on the main diagonal).
|
int |
hashCode()
Computes a hashcode for the matrix.
|
boolean |
isSquare()
Is this a square matrix?
|
FieldMatrix<T> |
multiply(FieldMatrix<T> m)
Returns the result of postmultiplying this by m.
|
abstract void |
multiplyEntry(int row,
int column,
T factor)
Change an entry in the specified row and column.
|
FieldVector<T> |
operate(FieldVector<T> v)
Returns the result of multiplying this by the vector
v . |
T[] |
operate(T[] v)
Returns the result of multiplying this by the vector
v . |
FieldMatrix<T> |
preMultiply(FieldMatrix<T> m)
Returns the result premultiplying this by
m . |
FieldVector<T> |
preMultiply(FieldVector<T> v)
Returns the (row) vector result of premultiplying this by the vector
v . |
T[] |
preMultiply(T[] v)
Returns the (row) vector result of premultiplying this by the vector
v . |
FieldMatrix<T> |
scalarAdd(T d)
Returns the result of adding d to each entry of this.
|
FieldMatrix<T> |
scalarMultiply(T d)
Returns the result multiplying each entry of this by d.
|
void |
setColumn(int column,
T[] array)
Sets the entries in column number
column
as a column matrix. |
void |
setColumnMatrix(int column,
FieldMatrix<T> matrix)
Sets the entries in column number
column
as a column matrix. |
void |
setColumnVector(int column,
FieldVector<T> vector)
Sets the entries in column number
column
as a vector. |
abstract void |
setEntry(int row,
int column,
T value)
Set the entry in the specified row and column.
|
void |
setRow(int row,
T[] array)
Sets the entries in row number
row
as a row matrix. |
void |
setRowMatrix(int row,
FieldMatrix<T> matrix)
Sets the entries in row number
row
as a row matrix. |
void |
setRowVector(int row,
FieldVector<T> vector)
Sets the entries in row number
row
as a vector. |
void |
setSubMatrix(T[][] subMatrix,
int row,
int column)
Replace the submatrix starting at
row, column using data in
the input subMatrix array. |
FieldMatrix<T> |
subtract(FieldMatrix<T> m)
Compute this minus m.
|
String |
toString()
Get a string representation for this matrix.
|
FieldMatrix<T> |
transpose()
Returns the transpose of this matrix.
|
T |
walkInColumnOrder(FieldMatrixChangingVisitor<T> visitor)
Visit (and possibly change) all matrix entries in column order.
|
T |
walkInColumnOrder(FieldMatrixChangingVisitor<T> visitor,
int startRow,
int endRow,
int startColumn,
int endColumn)
Visit (and possibly change) some matrix entries in column order.
|
T |
walkInColumnOrder(FieldMatrixPreservingVisitor<T> visitor)
Visit (but don't change) all matrix entries in column order.
|
T |
walkInColumnOrder(FieldMatrixPreservingVisitor<T> visitor,
int startRow,
int endRow,
int startColumn,
int endColumn)
Visit (but don't change) some matrix entries in column order.
|
T |
walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor)
Visit (and possibly change) all matrix entries using the fastest possible order.
|
T |
walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor,
int startRow,
int endRow,
int startColumn,
int endColumn)
Visit (and possibly change) some matrix entries using the fastest possible order.
|
T |
walkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor)
Visit (but don't change) all matrix entries using the fastest possible order.
|
T |
walkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor,
int startRow,
int endRow,
int startColumn,
int endColumn)
Visit (but don't change) some matrix entries using the fastest possible order.
|
T |
walkInRowOrder(FieldMatrixChangingVisitor<T> visitor)
Visit (and possibly change) all matrix entries in row order.
|
T |
walkInRowOrder(FieldMatrixChangingVisitor<T> visitor,
int startRow,
int endRow,
int startColumn,
int endColumn)
Visit (and possibly change) some matrix entries in row order.
|
T |
walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor)
Visit (but don't change) all matrix entries in row order.
|
T |
walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor,
int startRow,
int endRow,
int startColumn,
int endColumn)
Visit (but don't change) some matrix entries in row order.
|
private final Field<T extends FieldElement<T>> field
protected AbstractFieldMatrix()
protected AbstractFieldMatrix(Field<T> field)
field
- field to which the elements belongprotected AbstractFieldMatrix(Field<T> field, int rowDimension, int columnDimension) throws IllegalArgumentException
field
- field to which the elements belongrowDimension
- the number of rows in the new matrixcolumnDimension
- the number of columns in the new matrixIllegalArgumentException
- if row or column dimension is not positiveprotected static <T extends FieldElement<T>> Field<T> extractField(T[][] d) throws IllegalArgumentException
T
- the type of the field elementsd
- data arrayIllegalArgumentException
- if array is emptyprotected static <T extends FieldElement<T>> Field<T> extractField(T[] d) throws IllegalArgumentException
T
- the type of the field elementsd
- data arrayIllegalArgumentException
- if array is emptyprotected static <T extends FieldElement<T>> T[][] buildArray(Field<T> field, int rows, int columns)
Complete arrays are filled with field.getZero()
T
- the type of the field elementsfield
- field to which array elements belongrows
- number of rowscolumns
- number of columns (may be negative to build partial
arrays in the same way new Field[rows][]
works)protected static <T extends FieldElement<T>> T[] buildArray(Field<T> field, int length)
Arrays are filled with field.getZero()
T
- the type of the field elementsfield
- field to which array elements belonglength
- of the arraypublic Field<T> getField()
getField
in interface FieldMatrix<T extends FieldElement<T>>
public abstract FieldMatrix<T> createMatrix(int rowDimension, int columnDimension) throws IllegalArgumentException
createMatrix
in interface FieldMatrix<T extends FieldElement<T>>
rowDimension
- the number of rows in the new matrixcolumnDimension
- the number of columns in the new matrixIllegalArgumentException
- if row or column dimension is not positivepublic abstract FieldMatrix<T> copy()
copy
in interface FieldMatrix<T extends FieldElement<T>>
public FieldMatrix<T> add(FieldMatrix<T> m) throws IllegalArgumentException
add
in interface FieldMatrix<T extends FieldElement<T>>
m
- matrix to be addedIllegalArgumentException
- if m is not the same size as thispublic FieldMatrix<T> subtract(FieldMatrix<T> m) throws IllegalArgumentException
subtract
in interface FieldMatrix<T extends FieldElement<T>>
m
- matrix to be subtractedIllegalArgumentException
- if m is not the same size as thispublic FieldMatrix<T> scalarAdd(T d)
scalarAdd
in interface FieldMatrix<T extends FieldElement<T>>
d
- value to be added to each entrypublic FieldMatrix<T> scalarMultiply(T d)
scalarMultiply
in interface FieldMatrix<T extends FieldElement<T>>
d
- value to multiply all entries bypublic FieldMatrix<T> multiply(FieldMatrix<T> m) throws IllegalArgumentException
multiply
in interface FieldMatrix<T extends FieldElement<T>>
m
- matrix to postmultiply byIllegalArgumentException
- if columnDimension(this) != rowDimension(m)public FieldMatrix<T> preMultiply(FieldMatrix<T> m) throws IllegalArgumentException
m
.preMultiply
in interface FieldMatrix<T extends FieldElement<T>>
m
- matrix to premultiply byIllegalArgumentException
- if rowDimension(this) != columnDimension(m)public T[][] getData()
getData
in interface FieldMatrix<T extends FieldElement<T>>
public FieldMatrix<T> getSubMatrix(int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException
getSubMatrix
in interface FieldMatrix<T extends FieldElement<T>>
startRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)MatrixIndexException
- if the indices are not validpublic FieldMatrix<T> getSubMatrix(int[] selectedRows, int[] selectedColumns) throws MatrixIndexException
getSubMatrix
in interface FieldMatrix<T extends FieldElement<T>>
selectedRows
- Array of row indices.selectedColumns
- Array of column indices.MatrixIndexException
- if row or column selections are not validpublic void copySubMatrix(int startRow, int endRow, int startColumn, int endColumn, T[][] destination) throws MatrixIndexException, IllegalArgumentException
copySubMatrix
in interface FieldMatrix<T extends FieldElement<T>>
startRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)destination
- The arrays where the submatrix data should be copied
(if larger than rows/columns counts, only the upper-left part will be used)MatrixIndexException
- if the indices are not validIllegalArgumentException
- if the destination array is too smallpublic void copySubMatrix(int[] selectedRows, int[] selectedColumns, T[][] destination) throws MatrixIndexException, IllegalArgumentException
copySubMatrix
in interface FieldMatrix<T extends FieldElement<T>>
selectedRows
- Array of row indices.selectedColumns
- Array of column indices.destination
- The arrays where the submatrix data should be copied
(if larger than rows/columns counts, only the upper-left part will be used)MatrixIndexException
- if the indices are not validIllegalArgumentException
- if the destination array is too smallpublic void setSubMatrix(T[][] subMatrix, int row, int column) throws MatrixIndexException
row, column
using data in
the input subMatrix
array. Indexes are 0-based.
Example:
Starting with
1 2 3 4 5 6 7 8 9 0 1 2and
subMatrix = {{3, 4} {5,6}}
, invoking
setSubMatrix(subMatrix,1,1))
will result in 1 2 3 4 5 3 4 8 9 5 6 2
setSubMatrix
in interface FieldMatrix<T extends FieldElement<T>>
subMatrix
- array containing the submatrix replacement datarow
- row coordinate of the top, left element to be replacedcolumn
- column coordinate of the top, left element to be replacedMatrixIndexException
- if subMatrix does not fit into this
matrix from element in (row, column)public FieldMatrix<T> getRowMatrix(int row) throws MatrixIndexException
row
as a row matrix. Row indices start at 0.getRowMatrix
in interface FieldMatrix<T extends FieldElement<T>>
row
- the row to be fetchedMatrixIndexException
- if the specified row index is invalidpublic void setRowMatrix(int row, FieldMatrix<T> matrix) throws MatrixIndexException, InvalidMatrixException
row
as a row matrix. Row indices start at 0.setRowMatrix
in interface FieldMatrix<T extends FieldElement<T>>
row
- the row to be setmatrix
- row matrix (must have one row and the same number of columns
as the instance)MatrixIndexException
- if the specified row index is invalidInvalidMatrixException
- if the matrix dimensions do not match one
instance rowpublic FieldMatrix<T> getColumnMatrix(int column) throws MatrixIndexException
column
as a column matrix. Column indices start at 0.getColumnMatrix
in interface FieldMatrix<T extends FieldElement<T>>
column
- the column to be fetchedMatrixIndexException
- if the specified column index is invalidpublic void setColumnMatrix(int column, FieldMatrix<T> matrix) throws MatrixIndexException, InvalidMatrixException
column
as a column matrix. Column indices start at 0.setColumnMatrix
in interface FieldMatrix<T extends FieldElement<T>>
column
- the column to be setmatrix
- column matrix (must have one column and the same number of rows
as the instance)MatrixIndexException
- if the specified column index is invalidInvalidMatrixException
- if the matrix dimensions do not match one
instance columnpublic FieldVector<T> getRowVector(int row) throws MatrixIndexException
row
as a vector. Row indices start at 0.getRowVector
in interface FieldMatrix<T extends FieldElement<T>>
row
- the row to be fetchedMatrixIndexException
- if the specified row index is invalidpublic void setRowVector(int row, FieldVector<T> vector) throws MatrixIndexException, InvalidMatrixException
row
as a vector. Row indices start at 0.setRowVector
in interface FieldMatrix<T extends FieldElement<T>>
row
- the row to be setvector
- row vector (must have the same number of columns
as the instance)MatrixIndexException
- if the specified row index is invalidInvalidMatrixException
- if the vector dimension does not match one
instance rowpublic FieldVector<T> getColumnVector(int column) throws MatrixIndexException
column
as a vector. Column indices start at 0.getColumnVector
in interface FieldMatrix<T extends FieldElement<T>>
column
- the column to be fetchedMatrixIndexException
- if the specified column index is invalidpublic void setColumnVector(int column, FieldVector<T> vector) throws MatrixIndexException, InvalidMatrixException
column
as a vector. Column indices start at 0.setColumnVector
in interface FieldMatrix<T extends FieldElement<T>>
column
- the column to be setvector
- column vector (must have the same number of rows as the instance)MatrixIndexException
- if the specified column index is invalidInvalidMatrixException
- if the vector dimension does not match one
instance columnpublic T[] getRow(int row) throws MatrixIndexException
row
as an array.
Row indices start at 0. A MatrixIndexException
is thrown
unless 0 <= row < rowDimension.
getRow
in interface FieldMatrix<T extends FieldElement<T>>
row
- the row to be fetchedMatrixIndexException
- if the specified row index is not validpublic void setRow(int row, T[] array) throws MatrixIndexException, InvalidMatrixException
row
as a row matrix. Row indices start at 0.setRow
in interface FieldMatrix<T extends FieldElement<T>>
row
- the row to be setarray
- row matrix (must have the same number of columns as the instance)MatrixIndexException
- if the specified row index is invalidInvalidMatrixException
- if the array size does not match one
instance rowpublic T[] getColumn(int column) throws MatrixIndexException
col
as an array.
Column indices start at 0. A MatrixIndexException
is thrown
unless 0 <= column < columnDimension.
getColumn
in interface FieldMatrix<T extends FieldElement<T>>
column
- the column to be fetchedMatrixIndexException
- if the specified column index is not validpublic void setColumn(int column, T[] array) throws MatrixIndexException, InvalidMatrixException
column
as a column matrix. Column indices start at 0.setColumn
in interface FieldMatrix<T extends FieldElement<T>>
column
- the column to be setarray
- column array (must have the same number of rows as the instance)MatrixIndexException
- if the specified column index is invalidInvalidMatrixException
- if the array size does not match one
instance columnpublic abstract T getEntry(int row, int column) throws MatrixIndexException
Row and column indices start at 0 and must satisfy
0 <= row < rowDimension
0 <= column < columnDimension
MatrixIndexException
is thrown.getEntry
in interface FieldMatrix<T extends FieldElement<T>>
row
- row location of entry to be fetchedcolumn
- column location of entry to be fetchedMatrixIndexException
- if the row or column index is not validpublic abstract void setEntry(int row, int column, T value) throws MatrixIndexException
Row and column indices start at 0 and must satisfy
0 <= row < rowDimension
0 <= column < columnDimension
MatrixIndexException
is thrown.setEntry
in interface FieldMatrix<T extends FieldElement<T>>
row
- row location of entry to be setcolumn
- column location of entry to be setvalue
- matrix entry to be set in row,columnMatrixIndexException
- if the row or column index is not validpublic abstract void addToEntry(int row, int column, T increment) throws MatrixIndexException
Row and column indices start at 0 and must satisfy
0 <= row < rowDimension
0 <= column < columnDimension
MatrixIndexException
is thrown.addToEntry
in interface FieldMatrix<T extends FieldElement<T>>
row
- row location of entry to be setcolumn
- column location of entry to be setincrement
- value to add to the current matrix entry in row,columnMatrixIndexException
- if the row or column index is not validpublic abstract void multiplyEntry(int row, int column, T factor) throws MatrixIndexException
Row and column indices start at 0 and must satisfy
0 <= row < rowDimension
0 <= column < columnDimension
MatrixIndexException
is thrown.multiplyEntry
in interface FieldMatrix<T extends FieldElement<T>>
row
- row location of entry to be setcolumn
- column location of entry to be setfactor
- multiplication factor for the current matrix entry in row,columnMatrixIndexException
- if the row or column index is not validpublic FieldMatrix<T> transpose()
transpose
in interface FieldMatrix<T extends FieldElement<T>>
public boolean isSquare()
public abstract int getRowDimension()
getRowDimension
in interface AnyMatrix
public abstract int getColumnDimension()
getColumnDimension
in interface AnyMatrix
public T getTrace() throws NonSquareMatrixException
getTrace
in interface FieldMatrix<T extends FieldElement<T>>
NonSquareMatrixException
- if the matrix is not squarepublic T[] operate(T[] v) throws IllegalArgumentException
v
.operate
in interface FieldMatrix<T extends FieldElement<T>>
v
- the vector to operate onIllegalArgumentException
- if columnDimension != v.size()public FieldVector<T> operate(FieldVector<T> v) throws IllegalArgumentException
v
.operate
in interface FieldMatrix<T extends FieldElement<T>>
v
- the vector to operate onIllegalArgumentException
- if columnDimension != v.size()public T[] preMultiply(T[] v) throws IllegalArgumentException
v
.preMultiply
in interface FieldMatrix<T extends FieldElement<T>>
v
- the row vector to premultiply byIllegalArgumentException
- if rowDimension != v.size()public FieldVector<T> preMultiply(FieldVector<T> v) throws IllegalArgumentException
v
.preMultiply
in interface FieldMatrix<T extends FieldElement<T>>
v
- the row vector to premultiply byIllegalArgumentException
- if rowDimension != v.size()public T walkInRowOrder(FieldMatrixChangingVisitor<T> visitor) throws MatrixVisitorException
Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
walkInRowOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesFieldMatrixChangingVisitor.end()
at the end
of the walkMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
public T walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor) throws MatrixVisitorException
Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
walkInRowOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesFieldMatrixPreservingVisitor.end()
at the end
of the walkMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
public T walkInRowOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException, MatrixVisitorException
Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
walkInRowOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column indexFieldMatrixChangingVisitor.end()
at the end
of the walkMatrixIndexException
- if the indices are not validMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
public T walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException, MatrixVisitorException
Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
walkInRowOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column indexFieldMatrixPreservingVisitor.end()
at the end
of the walkMatrixIndexException
- if the indices are not validMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
public T walkInColumnOrder(FieldMatrixChangingVisitor<T> visitor) throws MatrixVisitorException
Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
walkInColumnOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesFieldMatrixChangingVisitor.end()
at the end
of the walkMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
public T walkInColumnOrder(FieldMatrixPreservingVisitor<T> visitor) throws MatrixVisitorException
Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
walkInColumnOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesFieldMatrixPreservingVisitor.end()
at the end
of the walkMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
public T walkInColumnOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException, MatrixVisitorException
Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
walkInColumnOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column indexFieldMatrixChangingVisitor.end()
at the end
of the walkMatrixIndexException
- if the indices are not validMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
public T walkInColumnOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException, MatrixVisitorException
Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
walkInColumnOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column indexFieldMatrixPreservingVisitor.end()
at the end
of the walkMatrixIndexException
- if the indices are not validMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
public T walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor) throws MatrixVisitorException
The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
walkInOptimizedOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesFieldMatrixChangingVisitor.end()
at the end
of the walkMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
public T walkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor) throws MatrixVisitorException
The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
walkInOptimizedOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesFieldMatrixPreservingVisitor.end()
at the end
of the walkMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
public T walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException, MatrixVisitorException
The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
walkInOptimizedOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)FieldMatrixChangingVisitor.end()
at the end
of the walkMatrixIndexException
- if the indices are not validMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
public T walkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException, MatrixVisitorException
The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
walkInOptimizedOrder
in interface FieldMatrix<T extends FieldElement<T>>
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)FieldMatrixPreservingVisitor.end()
at the end
of the walkMatrixIndexException
- if the indices are not validMatrixVisitorException
- if the visitor cannot process an entryFieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
,
FieldMatrix.walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor)
,
FieldMatrix.walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
public String toString()
public boolean equals(Object object)
object
is a
FieldMatrix
instance with the same dimensions as this
and all corresponding matrix entries are equal.public int hashCode()
protected void checkRowIndex(int row)
row
- row index to checkMatrixIndexException
- if index is not validprotected void checkColumnIndex(int column) throws MatrixIndexException
column
- column index to checkMatrixIndexException
- if index is not validprotected void checkSubMatrixIndex(int startRow, int endRow, int startColumn, int endColumn)
startRow
- Initial row indexendRow
- Final row indexstartColumn
- Initial column indexendColumn
- Final column indexMatrixIndexException
- if the indices are not validprotected void checkSubMatrixIndex(int[] selectedRows, int[] selectedColumns)
selectedRows
- Array of row indices.selectedColumns
- Array of column indices.MatrixIndexException
- if row or column selections are not validprotected void checkAdditionCompatible(FieldMatrix<T> m)
m
- matrix to checkIllegalArgumentException
- if matrix is not addition compatible with instanceprotected void checkSubtractionCompatible(FieldMatrix<T> m)
m
- matrix to checkIllegalArgumentException
- if matrix is not subtraction compatible with instanceprotected void checkMultiplicationCompatible(FieldMatrix<T> m)
m
- matrix to checkIllegalArgumentException
- if matrix is not multiplication compatible with instanceCopyright (c) 2003-2014 Apache Software Foundation