Class AbstractFieldMatrix<T extends FieldElement<T>>
- Type Parameters:
T
- Type of the field elements.
- All Implemented Interfaces:
AnyMatrix
,FieldMatrix<T>
,FieldBlendable<FieldMatrix<T>,
T>
- Direct Known Subclasses:
Array2DRowFieldMatrix
,BlockFieldMatrix
,SparseFieldMatrix
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.
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor for use with Serializableprotected
AbstractFieldMatrix
(Field<T> field) Creates a matrix with no dataprotected
AbstractFieldMatrix
(Field<T> field, int rowDimension, int columnDimension) Create a newFieldMatrix
with the supplied row and column dimensions. -
Method Summary
Modifier and TypeMethodDescriptionadd
(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 void
Check if a matrix is addition compatible with the instance.protected void
checkColumnIndex
(int column) Check if a column index is valid.protected void
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
Check if a matrix is subtraction compatible with the instance.abstract FieldMatrix<T>
copy()
Make 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 newFieldMatrix
of the same type as the instance with the supplied row and column dimensions.boolean
Returns true iffobject
is aFieldMatrix
instance with the same dimensions as this and all corresponding matrix entries are equal.protected static <T extends FieldElement<T>>
Field<T>extractField
(T[] d) Get the elements type from an array.protected static <T extends FieldElement<T>>
Field<T>extractField
(T[][] d) Get the elements type from an array.T[]
getColumn
(int column) Get the entries in column numbercol
as an array.abstract int
Returns the number of columns in the matrix.getColumnMatrix
(int column) Get the entries in column numbercolumn
as a column matrix.getColumnVector
(int column) Returns the entries in column numbercolumn
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.getField()
Get the type of field elements of the matrix.T[]
getRow
(int row) Get the entries in row numberrow
as an array.abstract int
Returns the number of rows in the matrix.getRowMatrix
(int row) Get the entries in row numberrow
as a row matrix.getRowVector
(int row) Get the entries in row numberrow
as a vector.getSubMatrix
(int[] selectedRows, int[] selectedColumns) Get a submatrix.getSubMatrix
(int startRow, int endRow, int startColumn, int endColumn) Get a submatrix.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?multiply
(FieldMatrix<T> m) Postmultiply this matrix bym
.abstract void
multiplyEntry
(int row, int column, T factor) Change an entry in the specified row and column.operate
(FieldVector<T> v) Returns the result of multiplying this by the vectorv
.T[]
Returns the result of multiplying this by the vectorv
.power
(int p) Returns the result multiplying this with itselfp
times.preMultiply
(FieldMatrix<T> m) Premultiply this matrix bym
.preMultiply
(FieldVector<T> v) Returns the (row) vector result of premultiplying this by the vectorv
.T[]
preMultiply
(T[] v) Returns the (row) vector result of premultiplying this by the vectorv
.Increment each entry of this matrix.scalarMultiply
(T d) Multiply each entry byd
.void
Set the entries in column numbercolumn
as a column matrix.void
setColumnMatrix
(int column, FieldMatrix<T> matrix) Set the entries in column numbercolumn
as a column matrix.void
setColumnVector
(int column, FieldVector<T> vector) Set the entries in column numbercolumn
as a vector.abstract void
Set the entry in the specified row and column.void
Set the entries in row numberrow
as a row matrix.void
setRowMatrix
(int row, FieldMatrix<T> matrix) Set the entries in row numberrow
as a row matrix.void
setRowVector
(int row, FieldVector<T> vector) Set the entries in row numberrow
as a vector.void
setSubMatrix
(T[][] subMatrix, int row, int column) Replace the submatrix starting at(row, column)
using data in the inputsubMatrix
array.subtract
(FieldMatrix<T> m) Subtractm
from this matrix.toString()
Get a string representation for this matrix.Returns the transpose of this matrix.walkInColumnOrder
(FieldMatrixChangingVisitor<T> visitor) Visit (and possibly change) all matrix entries in column order.walkInColumnOrder
(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (and possibly change) some matrix entries in column order.walkInColumnOrder
(FieldMatrixPreservingVisitor<T> visitor) Visit (but don't change) all matrix entries in column order.walkInColumnOrder
(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (but don't change) some matrix entries in column order.walkInOptimizedOrder
(FieldMatrixChangingVisitor<T> visitor) Visit (and possibly change) all matrix entries using the fastest possible order.walkInOptimizedOrder
(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (and possibly change) some matrix entries using the fastest possible order.Visit (but don't change) all matrix entries using the fastest possible order.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.walkInRowOrder
(FieldMatrixChangingVisitor<T> visitor) Visit (and possibly change) all matrix entries in row order.walkInRowOrder
(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (and possibly change) some matrix entries in row order.walkInRowOrder
(FieldMatrixPreservingVisitor<T> visitor) Visit (but don't change) all matrix entries in row order.walkInRowOrder
(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (but don't change) some matrix entries in row order.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hipparchus.linear.FieldMatrix
blendArithmeticallyWith, map, mapToSelf, multiplyTransposed, transposeMultiply
-
Constructor Details
-
AbstractFieldMatrix
protected AbstractFieldMatrix()Constructor for use with Serializable -
AbstractFieldMatrix
Creates a matrix with no data- Parameters:
field
- field to which the elements belong
-
AbstractFieldMatrix
protected AbstractFieldMatrix(Field<T> field, int rowDimension, int columnDimension) throws MathIllegalArgumentException Create a newFieldMatrix
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:
MathIllegalArgumentException
- if row or column dimension is not positive.
-
-
Method Details
-
extractField
protected static <T extends FieldElement<T>> Field<T> extractField(T[][] d) throws MathIllegalArgumentException, NullArgumentException Get the elements type from an array.- Type Parameters:
T
- Type of the field elements.- Parameters:
d
- Data array.- Returns:
- the field to which the array elements belong.
- Throws:
NullArgumentException
- if the array isnull
.MathIllegalArgumentException
- if the array is empty.
-
extractField
protected static <T extends FieldElement<T>> Field<T> extractField(T[] d) throws MathIllegalArgumentException Get the elements type from an array.- Type Parameters:
T
- Type of the field elements.- Parameters:
d
- Data array.- Returns:
- the field to which the array elements belong.
- Throws:
MathIllegalArgumentException
- if array is empty.
-
getField
Get the type of field elements of the matrix.- Specified by:
getField
in interfaceFieldMatrix<T extends FieldElement<T>>
- Returns:
- the type of field elements of the matrix.
-
createMatrix
public abstract FieldMatrix<T> createMatrix(int rowDimension, int columnDimension) throws MathIllegalArgumentException Create a newFieldMatrix
of the same type as the instance with the supplied row and column dimensions.- Specified by:
createMatrix
in interfaceFieldMatrix<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
- Throws:
MathIllegalArgumentException
- if row or column dimension is not positive.
-
copy
Make a (deep) copy of this.- Specified by:
copy
in interfaceFieldMatrix<T extends FieldElement<T>>
- Returns:
- a copy of this matrix.
-
add
Compute the sum of this and m.- Specified by:
add
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
m
- Matrix to be added.- Returns:
this
+m
.- Throws:
MathIllegalArgumentException
- ifm
is not the same size asthis
matrix.
-
subtract
Subtractm
from this matrix.- Specified by:
subtract
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
m
- Matrix to be subtracted.- Returns:
this
-m
.- Throws:
MathIllegalArgumentException
- ifm
is not the same size asthis
matrix.
-
scalarAdd
Increment each entry of this matrix.- Specified by:
scalarAdd
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
d
- Value to be added to each entry.- Returns:
d
+this
.
-
scalarMultiply
Multiply each entry byd
.- Specified by:
scalarMultiply
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
d
- Value to multiply all entries by.- Returns:
d
*this
.
-
multiply
Postmultiply this matrix bym
.- Specified by:
multiply
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
m
- Matrix to postmultiply by.- Returns:
this
*m
.- Throws:
MathIllegalArgumentException
- if the number of columns ofthis
matrix is not equal to the number of rows of matrixm
.
-
preMultiply
Premultiply this matrix bym
.- Specified by:
preMultiply
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
m
- Matrix to premultiply by.- Returns:
m
*this
.- Throws:
MathIllegalArgumentException
- if the number of columns ofm
differs from the number of rows ofthis
matrix.
-
power
Returns the result multiplying this with itselfp
times. Depending on the type of the field elements, T, instability for high powers might occur.- Specified by:
power
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
p
- raise this to power p- Returns:
- this^p
- Throws:
MathIllegalArgumentException
- ifp < 0
-
getData
Returns matrix entries as a two-dimensional array.- Specified by:
getData
in interfaceFieldMatrix<T extends FieldElement<T>>
- Returns:
- a 2-dimensional array of entries.
-
getSubMatrix
public FieldMatrix<T> getSubMatrix(int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Get a submatrix. Rows and columns are indicated counting from 0 to n - 1.- Specified by:
getSubMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
startRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)- Returns:
- the matrix containing the data of the specified rows and columns.
- Throws:
MathIllegalArgumentException
- isendRow < startRow
ofendColumn < startColumn
.
-
getSubMatrix
public FieldMatrix<T> getSubMatrix(int[] selectedRows, int[] selectedColumns) throws MathIllegalArgumentException, NullArgumentException Get a submatrix. Rows and columns are indicated counting from 0 to n - 1.- Specified by:
getSubMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
selectedRows
- Array of row indices.selectedColumns
- Array of column indices.- Returns:
- the matrix containing the data in the specified rows and columns.
- Throws:
MathIllegalArgumentException
- ifselectedRows
orselectedColumns
is emptyNullArgumentException
- ifselectedRows
orselectedColumns
isnull
.
-
copySubMatrix
public void copySubMatrix(int startRow, int endRow, int startColumn, int endColumn, T[][] destination) throws MathIllegalArgumentException Copy a submatrix. Rows and columns are 0-based. The designated submatrix is copied into the top left portion of the destination array.- Specified by:
copySubMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
startRow
- Initial row index.endRow
- Final row index (inclusive).startColumn
- Initial column index.endColumn
- Final column index (inclusive).destination
- The array where the submatrix data should be copied (if larger than rows/columns counts, only the upper-left part will be modified).- Throws:
MathIllegalArgumentException
- if the dimensions ofdestination
are not large enough to hold the submatrix.
-
copySubMatrix
public void copySubMatrix(int[] selectedRows, int[] selectedColumns, T[][] destination) throws MathIllegalArgumentException, NullArgumentException Copy a submatrix. Rows and columns are indicated counting from 0 to n - 1.- Specified by:
copySubMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
selectedRows
- Array of row indices.selectedColumns
- Array of column indices.destination
- Arrays where the submatrix data should be copied (if larger than rows/columns counts, only the upper-left part will be used)- Throws:
MathIllegalArgumentException
- if the dimensions ofdestination
do not match those ofthis
.NullArgumentException
- ifselectedRows
orselectedColumns
isnull
.
-
setSubMatrix
public void setSubMatrix(T[][] subMatrix, int row, int column) throws MathIllegalArgumentException, NullArgumentException Replace the submatrix starting at(row, column)
using data in the inputsubMatrix
array. Indexes are 0-based.Example:
Starting with1 2 3 4 5 6 7 8 9 0 1 2
and
subMatrix = {{3, 4} {5,6}}
, invokingsetSubMatrix(subMatrix,1,1))
will result in1 2 3 4 5 3 4 8 9 5 6 2
- Specified by:
setSubMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
subMatrix
- Array containing the submatrix replacement data.row
- Row coordinate of the top-left element to be replaced.column
- Column coordinate of the top-left element to be replaced.- Throws:
MathIllegalArgumentException
- ifsubMatrix
does not fit into this matrix from element in(row, column)
.NullArgumentException
- ifsubMatrix
isnull
.
-
getRowMatrix
Get the entries in row numberrow
as a row matrix.- Specified by:
getRowMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
row
- Row to be fetched.- Returns:
- a row matrix.
- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.
-
setRowMatrix
Set the entries in row numberrow
as a row matrix.- Specified by:
setRowMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
row
- Row to be set.matrix
- Row matrix (must have one row and the same number of columns as the instance).- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.
-
getColumnMatrix
Get the entries in column numbercolumn
as a column matrix.- Specified by:
getColumnMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
column
- Column to be fetched.- Returns:
- a column matrix.
- Throws:
MathIllegalArgumentException
- if the specified column index is invalid.
-
setColumnMatrix
Set the entries in column numbercolumn
as a column matrix.- Specified by:
setColumnMatrix
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
column
- Column to be set.matrix
- column matrix (must have one column and the same number of rows as the instance).- Throws:
MathIllegalArgumentException
- if the specified column index is invalid.
-
getRowVector
Get the entries in row numberrow
as a vector.- Specified by:
getRowVector
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
row
- Row to be fetched- Returns:
- a row vector.
- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.
-
setRowVector
Set the entries in row numberrow
as a vector.- Specified by:
setRowVector
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
row
- Row to be set.vector
- row vector (must have the same number of columns as the instance).- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.
-
getColumnVector
Returns the entries in column numbercolumn
as a vector.- Specified by:
getColumnVector
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
column
- Column to be fetched.- Returns:
- a column vector.
- Throws:
MathIllegalArgumentException
- if the specified column index is invalid.
-
setColumnVector
Set the entries in column numbercolumn
as a vector.- Specified by:
setColumnVector
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
column
- Column to be set.vector
- Column vector (must have the same number of rows as the instance).- Throws:
MathIllegalArgumentException
- if the specified column index is invalid.
-
getRow
Get the entries in row numberrow
as an array.- Specified by:
getRow
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
row
- Row to be fetched.- Returns:
- array of entries in the row.
- Throws:
MathIllegalArgumentException
- if the specified row index is not valid.
-
setRow
Set the entries in row numberrow
as a row matrix.- Specified by:
setRow
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
row
- Row to be set.array
- Row matrix (must have the same number of columns as the instance).- Throws:
MathIllegalArgumentException
- if the specified row index is invalid.
-
getColumn
Get the entries in column numbercol
as an array.- Specified by:
getColumn
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
column
- the column to be fetched- Returns:
- array of entries in the column
- Throws:
MathIllegalArgumentException
- if the specified column index is not valid.
-
setColumn
Set the entries in column numbercolumn
as a column matrix.- Specified by:
setColumn
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
column
- the column to be setarray
- column array (must have the same number of rows as the instance)- Throws:
MathIllegalArgumentException
- if the specified column index is invalid.
-
getEntry
Returns the entry in the specified row and column.- Specified by:
getEntry
in interfaceFieldMatrix<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
- Throws:
MathIllegalArgumentException
- if the row or column index is not valid.
-
setEntry
Set the entry in the specified row and column.- Specified by:
setEntry
in interfaceFieldMatrix<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- Throws:
MathIllegalArgumentException
- if the row or column index is not valid.
-
addToEntry
public abstract void addToEntry(int row, int column, T increment) throws MathIllegalArgumentException Change an entry in the specified row and column.- Specified by:
addToEntry
in interfaceFieldMatrix<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)
.- Throws:
MathIllegalArgumentException
- if the row or column index is not valid.
-
multiplyEntry
public abstract void multiplyEntry(int row, int column, T factor) throws MathIllegalArgumentException Change an entry in the specified row and column.- Specified by:
multiplyEntry
in interfaceFieldMatrix<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)
- Throws:
MathIllegalArgumentException
- if the row or column index is not valid.
-
transpose
Returns the transpose of this matrix.- Specified by:
transpose
in interfaceFieldMatrix<T extends FieldElement<T>>
- Returns:
- transpose matrix
-
isSquare
public boolean isSquare()Is this a square matrix? -
getRowDimension
public abstract int getRowDimension()Returns the number of rows in the matrix.- Specified by:
getRowDimension
in interfaceAnyMatrix
- Returns:
- rowDimension
-
getColumnDimension
public abstract int getColumnDimension()Returns the number of columns in the matrix.- Specified by:
getColumnDimension
in interfaceAnyMatrix
- Returns:
- columnDimension
-
getTrace
Returns the trace of the matrix (the sum of the elements on the main diagonal).- Specified by:
getTrace
in interfaceFieldMatrix<T extends FieldElement<T>>
- Returns:
- trace
- Throws:
MathIllegalArgumentException
- if the matrix is not square.
-
operate
Returns the result of multiplying this by the vectorv
.- Specified by:
operate
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
v
- the vector to operate on- Returns:
this * v
- Throws:
MathIllegalArgumentException
- if the number of columns ofthis
matrix is not equal to the size of the vectorv
.
-
operate
Returns the result of multiplying this by the vectorv
.- Specified by:
operate
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
v
- the vector to operate on- Returns:
this * v
- Throws:
MathIllegalArgumentException
- if the number of columns ofthis
matrix is not equal to the size of the vectorv
.
-
preMultiply
Returns the (row) vector result of premultiplying this by the vectorv
.- Specified by:
preMultiply
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
v
- the row vector to premultiply by- Returns:
v * this
- Throws:
MathIllegalArgumentException
- if the number of rows ofthis
matrix is not equal to the size of the vectorv
-
preMultiply
Returns the (row) vector result of premultiplying this by the vectorv
.- Specified by:
preMultiply
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
v
- the row vector to premultiply by- Returns:
v * this
- Throws:
MathIllegalArgumentException
- if the number of rows ofthis
matrix is not equal to the size of the vectorv
-
walkInRowOrder
Visit (and possibly change) all matrix entries in row order.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.
- Specified by:
walkInRowOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()
at the end of the walk - See Also:
-
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)
FieldMatrix.walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInRowOrder
Visit (but don't change) all matrix entries in row order.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.
- Specified by:
walkInRowOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()
at the end of the walk - See Also:
-
FieldMatrix.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)
-
walkInRowOrder
public T walkInRowOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (and possibly change) some matrix entries in row order.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.
- Specified by:
walkInRowOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- if the indices are not valid.- See Also:
-
FieldMatrix.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)
-
walkInRowOrder
public T walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (but don't change) some matrix entries in row order.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.
- Specified by:
walkInRowOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- if the indices are not valid.- See Also:
-
FieldMatrix.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)
-
walkInColumnOrder
Visit (and possibly change) all matrix entries in column order.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.
- Specified by:
walkInColumnOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()
at the end of the walk - See Also:
-
FieldMatrix.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)
-
walkInColumnOrder
Visit (but don't change) all matrix entries in column order.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.
- Specified by:
walkInColumnOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()
at the end of the walk - See Also:
-
FieldMatrix.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)
-
walkInColumnOrder
public T walkInColumnOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (and possibly change) some matrix entries in column order.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.
- Specified by:
walkInColumnOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
FieldMatrix.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)
-
walkInColumnOrder
public T walkInColumnOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (but don't change) some matrix entries in column order.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.
- Specified by:
walkInColumnOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
FieldMatrix.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)
-
walkInOptimizedOrder
Visit (and possibly change) all matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()
at the end of the walk - See Also:
-
FieldMatrix.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)
-
walkInOptimizedOrder
Visit (but don't change) all matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()
at the end of the walk - See Also:
-
FieldMatrix.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)
-
walkInOptimizedOrder
public T walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (and possibly change) some matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
FieldMatrix.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)
-
walkInOptimizedOrder
public T walkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor, int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Visit (but don't change) some matrix entries using the fastest possible order.The fastest walking order depends on the exact matrix class. It may be different from traditional row or column orders.
- Specified by:
walkInOptimizedOrder
in interfaceFieldMatrix<T extends FieldElement<T>>
- Parameters:
visitor
- visitor used to process all matrix entriesstartRow
- Initial row indexendRow
- Final row index (inclusive)startColumn
- Initial column indexendColumn
- Final column index (inclusive)- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()
at the end of the walk - Throws:
MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
FieldMatrix.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)
-
toString
Get a string representation for this matrix. -
equals
Returns true iffobject
is aFieldMatrix
instance with the same dimensions as this and all corresponding matrix entries are equal. -
hashCode
public int hashCode()Computes a hashcode for the matrix. -
checkRowIndex
Check if a row index is valid.- Parameters:
row
- Row index to check.- Throws:
MathIllegalArgumentException
- ifindex
is not valid.
-
checkColumnIndex
Check if a column index is valid.- Parameters:
column
- Column index to check.- Throws:
MathIllegalArgumentException
- ifindex
is not valid.
-
checkSubMatrixIndex
protected void checkSubMatrixIndex(int startRow, int endRow, int startColumn, int endColumn) throws MathIllegalArgumentException Check if submatrix ranges indices are valid. Rows and columns are indicated counting from 0 to n-1.- Parameters:
startRow
- Initial row index.endRow
- Final row index.startColumn
- Initial column index.endColumn
- Final column index.- Throws:
MathIllegalArgumentException
- if the indices are not valid.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.
-
checkSubMatrixIndex
protected void checkSubMatrixIndex(int[] selectedRows, int[] selectedColumns) throws MathIllegalArgumentException, NullArgumentException Check if submatrix ranges indices are valid. Rows and columns are indicated counting from 0 to n-1.- Parameters:
selectedRows
- Array of row indices.selectedColumns
- Array of column indices.- Throws:
NullArgumentException
- if the arrays arenull
.MathIllegalArgumentException
- if the arrays have zero length.MathIllegalArgumentException
- if row or column selections are not valid.
-
checkAdditionCompatible
Check if a matrix is addition compatible with the instance.- Parameters:
m
- Matrix to check.- Throws:
MathIllegalArgumentException
- if the matrix is not addition-compatible with instance.
-
checkSubtractionCompatible
Check if a matrix is subtraction compatible with the instance.- Parameters:
m
- Matrix to check.- Throws:
MathIllegalArgumentException
- if the matrix is not subtraction-compatible with instance.
-
checkMultiplicationCompatible
Check if a matrix is multiplication compatible with the instance.- Parameters:
m
- Matrix to check.- Throws:
MathIllegalArgumentException
- if the matrix is not multiplication-compatible with instance.
-