Interface FieldMatrix<T extends FieldElement<T>>
- Type Parameters:
T
- the type of the field elements
- All Superinterfaces:
AnyMatrix
,FieldBlendable<FieldMatrix<T>,
T>
- All Known Implementing Classes:
AbstractFieldMatrix
,Array2DRowFieldMatrix
,BlockFieldMatrix
,SparseFieldMatrix
Matrix element indexing is 0-based -- e.g., getEntry(0, 0)
returns the element in the first row, first column of the matrix.
-
Method Summary
Modifier and TypeMethodDescriptionadd
(FieldMatrix<T> m) Compute the sum of this and m.void
addToEntry
(int row, int column, T increment) Change an entry in the specified row and column.default FieldMatrix<T>
blendArithmeticallyWith
(FieldMatrix<T> other, T blendingValue) Blend arithmetically this instance with another one.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.createMatrix
(int rowDimension, int columnDimension) Create a newFieldMatrix
of the same type as the instance with the supplied row and column dimensions.T[]
getColumn
(int column) Get the entries in column numbercol
as an array.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.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.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).default FieldMatrix<T>
Acts as if implemented as:default FieldMatrix<T>
Replace each entry by the result of applying the function to it.multiply
(FieldMatrix<T> m) Postmultiply this matrix bym
.void
multiplyEntry
(int row, int column, T factor) Change an entry in the specified row and column.default FieldMatrix<T>
Returns the result of postmultiplyingthis
bym^T
.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.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.Returns the transpose of this matrix.default FieldMatrix<T>
Returns the result of postmultiplyingthis^T
bym
.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 interface org.hipparchus.linear.AnyMatrix
getColumnDimension, getRowDimension, isSquare
-
Method Details
-
getField
Get the type of field elements of the matrix.- Returns:
- the type of field elements of the matrix.
-
createMatrix
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.- 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
FieldMatrix<T> copy()Make a (deep) copy of this.- Returns:
- a copy of this matrix.
-
add
Compute the sum of this and m.- Parameters:
m
- Matrix to be added.- Returns:
this
+m
.- Throws:
MathIllegalArgumentException
- ifm
is not the same size asthis
matrix.
-
subtract
Subtractm
from this matrix.- 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.- Parameters:
d
- Value to be added to each entry.- Returns:
d
+this
.
-
scalarMultiply
Multiply each entry byd
.- Parameters:
d
- Value to multiply all entries by.- Returns:
d
*this
.
-
multiply
Postmultiply this matrix bym
.- 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
.
-
multiplyTransposed
Returns the result of postmultiplyingthis
bym^T
.This is equivalent to call
multiply
(m.transpose()
), but some implementations may avoid building the intermediate transposed matrix.- Parameters:
m
- matrix to first transpose and second postmultiply by- Returns:
this * m^T
- Throws:
MathIllegalArgumentException
- ifcolumnDimension(this) != columnDimension(m)
- Since:
- 1.3
-
transposeMultiply
Returns the result of postmultiplyingthis^T
bym
.This is equivalent to call
transpose()
.multiply(m)
, but some implementations may avoid building the intermediate transposed matrix.- Parameters:
m
- matrix to postmultiply by- Returns:
this^T * m
- Throws:
MathIllegalArgumentException
- ifcolumnDimension(this) != columnDimension(m)
- Since:
- 1.3
-
preMultiply
Premultiply this matrix bym
.- 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.- Parameters:
p
- raise this to power p- Returns:
- this^p
- Throws:
MathIllegalArgumentException
- ifp < 0
MathIllegalArgumentException
- ifthis matrix
is not square
-
blendArithmeticallyWith
Blend arithmetically this instance with another one.- Specified by:
blendArithmeticallyWith
in interfaceFieldBlendable<FieldMatrix<T extends FieldElement<T>>,
T extends FieldElement<T>> - Parameters:
other
- other instance to blend arithmetically withblendingValue
- value from smoothstep function B(x). It is expected to be between [0:1] and will throw an exception otherwise.- Returns:
- this * (1 - B(x)) + other * B(x)
-
getData
T[][] getData()Returns matrix entries as a two-dimensional array.- Returns:
- a 2-dimensional array of entries.
-
getSubMatrix
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.- 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
.MathIllegalArgumentException
- if the indices are not valid.
-
getSubMatrix
FieldMatrix<T> getSubMatrix(int[] selectedRows, int[] selectedColumns) throws MathIllegalArgumentException, NullArgumentException Get a submatrix. Rows and columns are indicated counting from 0 to n - 1.- 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
.MathIllegalArgumentException
- if row or column selections are not valid.
-
copySubMatrix
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.- 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.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.MathIllegalArgumentException
- if the indices are not valid.
-
copySubMatrix
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.- 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
.MathIllegalArgumentException
- ifselectedRows
orselectedColumns
is emptyNullArgumentException
- ifselectedRows
orselectedColumns
isnull
.MathIllegalArgumentException
- if the indices are not valid.
-
setSubMatrix
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
- 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)
.MathIllegalArgumentException
- if a row or column ofsubMatrix
is empty.MathIllegalArgumentException
- ifsubMatrix
is not rectangular (not all rows have the same length).NullArgumentException
- ifsubMatrix
isnull
.
-
getRowMatrix
Get the entries in row numberrow
as a row matrix.- 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.- 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.MathIllegalArgumentException
- if the matrix dimensions do not match one instance row.
-
getColumnMatrix
Get the entries in column numbercolumn
as a column matrix.- 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.- 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.MathIllegalArgumentException
- if the matrix dimensions do not match one instance column.
-
getRowVector
Get the entries in row numberrow
as a vector.- 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.- 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.MathIllegalArgumentException
- if the vector dimension does not match one instance row.
-
getColumnVector
Returns the entries in column numbercolumn
as a vector.- 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.- 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.MathIllegalArgumentException
- if the vector dimension does not match one instance column.
-
getRow
Get the entries in row numberrow
as an array.- 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.- 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.MathIllegalArgumentException
- if the array size does not match one instance row.
-
getColumn
Get the entries in column numbercol
as an array.- 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.- 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.MathIllegalArgumentException
- if the array size does not match one instance column.
-
getEntry
Returns the entry in the specified row and column.- 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.- 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
Change an entry in the specified row and column.- 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
Change an entry in the specified row and column.- 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
FieldMatrix<T> transpose()Returns the transpose of this matrix.- Returns:
- transpose matrix
-
getTrace
Returns the trace of the matrix (the sum of the elements on the main diagonal).- Returns:
- trace
- Throws:
MathIllegalArgumentException
- if the matrix is not square.
-
operate
Returns the result of multiplying this by the vectorv
.- 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
.- 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
.- 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
.- 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.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(FieldMatrixPreservingVisitor)
walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixChangingVisitor)
walkInColumnOrder(FieldMatrixPreservingVisitor)
walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixChangingVisitor)
walkInOptimizedOrder(FieldMatrixPreservingVisitor)
walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
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.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(FieldMatrixChangingVisitor)
walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixChangingVisitor)
walkInColumnOrder(FieldMatrixPreservingVisitor)
walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixChangingVisitor)
walkInOptimizedOrder(FieldMatrixPreservingVisitor)
walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInRowOrder
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.
- 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.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
walkInRowOrder(FieldMatrixChangingVisitor)
walkInRowOrder(FieldMatrixPreservingVisitor)
walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixChangingVisitor)
walkInColumnOrder(FieldMatrixPreservingVisitor)
walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixChangingVisitor)
walkInOptimizedOrder(FieldMatrixPreservingVisitor)
walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInRowOrder
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.
- 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.MathIllegalArgumentException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
walkInRowOrder(FieldMatrixChangingVisitor)
walkInRowOrder(FieldMatrixPreservingVisitor)
walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixChangingVisitor)
walkInColumnOrder(FieldMatrixPreservingVisitor)
walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixChangingVisitor)
walkInOptimizedOrder(FieldMatrixPreservingVisitor)
walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
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.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(FieldMatrixChangingVisitor)
walkInRowOrder(FieldMatrixPreservingVisitor)
walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixPreservingVisitor)
walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixChangingVisitor)
walkInOptimizedOrder(FieldMatrixPreservingVisitor)
walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
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.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(FieldMatrixChangingVisitor)
walkInRowOrder(FieldMatrixPreservingVisitor)
walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixChangingVisitor)
walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixChangingVisitor)
walkInOptimizedOrder(FieldMatrixPreservingVisitor)
walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInColumnOrder
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.
- 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
.MathIllegalArgumentException
- if the indices are not valid.- See Also:
-
walkInRowOrder(FieldMatrixChangingVisitor)
walkInRowOrder(FieldMatrixPreservingVisitor)
walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixChangingVisitor)
walkInColumnOrder(FieldMatrixPreservingVisitor)
walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixChangingVisitor)
walkInOptimizedOrder(FieldMatrixPreservingVisitor)
walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInColumnOrder
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.
- 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
.MathIllegalArgumentException
- if the indices are not valid.- See Also:
-
walkInRowOrder(FieldMatrixChangingVisitor)
walkInRowOrder(FieldMatrixPreservingVisitor)
walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixChangingVisitor)
walkInColumnOrder(FieldMatrixPreservingVisitor)
walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixChangingVisitor)
walkInOptimizedOrder(FieldMatrixPreservingVisitor)
walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
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.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixChangingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(FieldMatrixChangingVisitor)
walkInRowOrder(FieldMatrixPreservingVisitor)
walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixChangingVisitor)
walkInColumnOrder(FieldMatrixPreservingVisitor)
walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixPreservingVisitor)
walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
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.
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
FieldMatrixPreservingVisitor.end()
at the end of the walk - See Also:
-
walkInRowOrder(FieldMatrixChangingVisitor)
walkInRowOrder(FieldMatrixPreservingVisitor)
walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixChangingVisitor)
walkInColumnOrder(FieldMatrixPreservingVisitor)
walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixChangingVisitor)
walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInOptimizedOrder
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.
- 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
.MathIllegalArgumentException
- if the indices are not valid.- See Also:
-
walkInRowOrder(FieldMatrixChangingVisitor)
walkInRowOrder(FieldMatrixPreservingVisitor)
walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixChangingVisitor)
walkInColumnOrder(FieldMatrixPreservingVisitor)
walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixChangingVisitor)
walkInOptimizedOrder(FieldMatrixPreservingVisitor)
walkInOptimizedOrder(FieldMatrixPreservingVisitor, int, int, int, int)
-
walkInOptimizedOrder
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.
- 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
.MathIllegalArgumentException
- if the indices are not valid.- See Also:
-
walkInRowOrder(FieldMatrixChangingVisitor)
walkInRowOrder(FieldMatrixPreservingVisitor)
walkInRowOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInRowOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixChangingVisitor)
walkInColumnOrder(FieldMatrixPreservingVisitor)
walkInColumnOrder(FieldMatrixChangingVisitor, int, int, int, int)
walkInColumnOrder(FieldMatrixPreservingVisitor, int, int, int, int)
walkInOptimizedOrder(FieldMatrixChangingVisitor)
walkInOptimizedOrder(FieldMatrixPreservingVisitor)
walkInOptimizedOrder(FieldMatrixChangingVisitor, int, int, int, int)
-
map
Acts as if implemented as:return copy().mapToSelf(function);
Returns a new matrix. Does not change instance data.- Parameters:
function
- Function to apply to each entry.- Returns:
- a new matrix.
- Since:
- 1.7
-
mapToSelf
Replace each entry by the result of applying the function to it.- Parameters:
function
- Function to apply to each entry.- Returns:
- a reference to this matrix.
- Since:
- 1.7
-