FieldMatrix (Hipparchus 2.0 API)

Type Parameters:

T - the type of the field elements

All Superinterfaces:

AnyMatrix

All Known Implementing Classes:

AbstractFieldMatrix, Array2DRowFieldMatrix, BlockFieldMatrix, SparseFieldMatrix
```
public interface FieldMatrix<T extends FieldElement<T>>
extends AnyMatrix
```
Interface defining field-valued matrix with basic algebraic operations.
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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`FieldMatrix<T>`	`add(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.
`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.
`FieldMatrix<T>`	`createMatrix(int rowDimension, int columnDimension)` Create a new FieldMatrix of the same type as the instance with the supplied row and column dimensions.
`T[]`	`getColumn(int column)` Get the entries in column number `col` as an array.
`FieldMatrix<T>`	`getColumnMatrix(int column)` Get 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.
`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)` Get the entries in row number `row` as an array.
`FieldMatrix<T>`	`getRowMatrix(int row)` Get the entries in row number `row` as a row matrix.
`FieldVector<T>`	`getRowVector(int row)` Get the entries in row number `row` as a vector.
`FieldMatrix<T>`	`getSubMatrix(int[] selectedRows, int[] selectedColumns)` Get a submatrix.
`FieldMatrix<T>`	`getSubMatrix(int startRow, int endRow, int startColumn, int endColumn)` Get a submatrix.
`T`	`getTrace()` Returns the trace of the matrix (the sum of the elements on the main diagonal).
`default FieldMatrix<T>`	`map(Function<T,T> function)` Acts as if implemented as:
`default FieldMatrix<T>`	`mapToSelf(Function<T,T> function)` Replace each entry by the result of applying the function to it.
`FieldMatrix<T>`	`multiply(FieldMatrix<T> m)` Postmultiply this matrix by `m`.
`void`	`multiplyEntry(int row, int column, T factor)` Change an entry in the specified row and column.
`default FieldMatrix<T>`	`multiplyTransposed(FieldMatrix<T> m)` Returns the result of postmultiplying `this` by `m^T`.
`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>`	`power(int p)` Returns the result multiplying this with itself `p` times.
`FieldMatrix<T>`	`preMultiply(FieldMatrix<T> m)` Premultiply this matrix 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)` Increment each entry of this matrix.
`FieldMatrix<T>`	`scalarMultiply(T d)` Multiply each entry by `d`.
`void`	`setColumn(int column, T[] array)` Set the entries in column number `column` as a column matrix.
`void`	`setColumnMatrix(int column, FieldMatrix<T> matrix)` Set the entries in column number `column` as a column matrix.
`void`	`setColumnVector(int column, FieldVector<T> vector)` Set the entries in column number `column` as a vector.
`void`	`setEntry(int row, int column, T value)` Set the entry in the specified row and column.
`void`	`setRow(int row, T[] array)` Set the entries in row number `row` as a row matrix.
`void`	`setRowMatrix(int row, FieldMatrix<T> matrix)` Set the entries in row number `row` as a row matrix.
`void`	`setRowVector(int row, FieldVector<T> vector)` Set 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)` Subtract `m` from this matrix.
`FieldMatrix<T>`	`transpose()` Returns the transpose of this matrix.
`default FieldMatrix<T>`	`transposeMultiply(FieldMatrix<T> m)` Returns the result of postmultiplying `this^T` by `m`.
`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.

Methods inherited from interface org.hipparchus.linear.AnyMatrix
getColumnDimension, getRowDimension, isSquare

- Method Detail
  - getField
```
Field<T> 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 new FieldMatrix of the same type as the instance with the supplied row and column dimensions.
    
    Parameters:
    
    rowDimension - the number of rows in the new matrix
    
    columnDimension - 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
```
FieldMatrix<T> add(FieldMatrix<T> m)
            throws MathIllegalArgumentException
```
    Compute the sum of this and m.
    
    Parameters:
    
    m - Matrix to be added.
    
    Returns:
    
    this + m.
    
    Throws:
    
    MathIllegalArgumentException - if m is not the same size as this matrix.
  - subtract
```
FieldMatrix<T> subtract(FieldMatrix<T> m)
                 throws MathIllegalArgumentException
```
    Subtract m from this matrix.
    
    Parameters:
    
    m - Matrix to be subtracted.
    
    Returns:
    
    this - m.
    
    Throws:
    
    MathIllegalArgumentException - if m is not the same size as this matrix.
  - scalarAdd
```
FieldMatrix<T> scalarAdd(T d)
```
    Increment each entry of this matrix.
    
    Parameters:
    
    d - Value to be added to each entry.
    
    Returns:
    
    d + this.
  - scalarMultiply
```
FieldMatrix<T> scalarMultiply(T d)
```
    Multiply each entry by d.
    
    Parameters:
    
    d - Value to multiply all entries by.
    
    Returns:
    
    d * this.
  - multiply
```
FieldMatrix<T> multiply(FieldMatrix<T> m)
                 throws MathIllegalArgumentException
```
    Postmultiply this matrix by m.
    
    Parameters:
    
    m - Matrix to postmultiply by.
    
    Returns:
    
    this * m.
    
    Throws:
    
    MathIllegalArgumentException - if the number of columns of this matrix is not equal to the number of rows of matrix m.
  - multiplyTransposed
```
default FieldMatrix<T> multiplyTransposed(FieldMatrix<T> m)
                                   throws MathIllegalArgumentException
```
    Returns the result of postmultiplying this by m^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 - if columnDimension(this) != columnDimension(m)
    
    Since:
    
    1.3
  - transposeMultiply
```
default FieldMatrix<T> transposeMultiply(FieldMatrix<T> m)
                                  throws MathIllegalArgumentException
```
    Returns the result of postmultiplying this^T by m.
    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 - if columnDimension(this) != columnDimension(m)
    
    Since:
    
    1.3
  - preMultiply
```
FieldMatrix<T> preMultiply(FieldMatrix<T> m)
                    throws MathIllegalArgumentException
```
    Premultiply this matrix by m.
    
    Parameters:
    
    m - Matrix to premultiply by.
    
    Returns:
    
    m * this.
    
    Throws:
    
    MathIllegalArgumentException - if the number of columns of m differs from the number of rows of this matrix.
  - power
```
FieldMatrix<T> power(int p)
              throws MathIllegalArgumentException
```
    Returns the result multiplying this with itself p 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 - if p < 0
    
    MathIllegalArgumentException - if this matrix is not square
  - 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 index
    
    endRow - Final row index (inclusive)
    
    startColumn - Initial column index
    
    endColumn - Final column index (inclusive)
    
    Returns:
    
    the matrix containing the data of the specified rows and columns.
    
    Throws:
    
    MathIllegalArgumentException - is endRow < startRow of endColumn < 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 - if selectedRows or selectedColumns is empty
    
    NullArgumentException - if selectedRows or selectedColumns is null.
    
    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 of destination are not large enough to hold the submatrix.
    
    MathIllegalArgumentException - if endRow < startRow or endColumn < 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 of destination do not match those of this.
    
    MathIllegalArgumentException - if selectedRows or selectedColumns is empty
    
    NullArgumentException - if selectedRows or selectedColumns is null.
    
    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 input subMatrix array. Indexes are 0-based.
    Example:
    Starting with
```
 1  2  3  4
 5  6  7  8
 9  0  1  2
 
```
    and 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
 
```
    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 - if subMatrix does not fit into this matrix from element in (row, column).
    
    MathIllegalArgumentException - if a row or column of subMatrix is empty.
    
    MathIllegalArgumentException - if subMatrix is not rectangular (not all rows have the same length).
    
    NullArgumentException - if subMatrix is null.
  - getRowMatrix
```
FieldMatrix<T> getRowMatrix(int row)
                     throws MathIllegalArgumentException
```
    Get the entries in row number row as a row matrix.
    
    Parameters:
    
    row - Row to be fetched.
    
    Returns:
    
    a row matrix.
    
    Throws:
    
    MathIllegalArgumentException - if the specified row index is invalid.
  - setRowMatrix
```
void setRowMatrix(int row,
                  FieldMatrix<T> matrix)
           throws MathIllegalArgumentException
```
    Set the entries in row number row 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
```
FieldMatrix<T> getColumnMatrix(int column)
                        throws MathIllegalArgumentException
```
    Get the entries in column number column as a column matrix.
    
    Parameters:
    
    column - Column to be fetched.
    
    Returns:
    
    a column matrix.
    
    Throws:
    
    MathIllegalArgumentException - if the specified column index is invalid.
  - setColumnMatrix
```
void setColumnMatrix(int column,
                     FieldMatrix<T> matrix)
              throws MathIllegalArgumentException
```
    Set the entries in column number column 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
```
FieldVector<T> getRowVector(int row)
                     throws MathIllegalArgumentException
```
    Get the entries in row number row as a vector.
    
    Parameters:
    
    row - Row to be fetched
    
    Returns:
    
    a row vector.
    
    Throws:
    
    MathIllegalArgumentException - if the specified row index is invalid.
  - setRowVector
```
void setRowVector(int row,
                  FieldVector<T> vector)
           throws MathIllegalArgumentException
```
    Set the entries in row number row 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
```
FieldVector<T> getColumnVector(int column)
                        throws MathIllegalArgumentException
```
    Returns the entries in column number column as a vector.
    
    Parameters:
    
    column - Column to be fetched.
    
    Returns:
    
    a column vector.
    
    Throws:
    
    MathIllegalArgumentException - if the specified column index is invalid.
  - setColumnVector
```
void setColumnVector(int column,
                     FieldVector<T> vector)
              throws MathIllegalArgumentException
```
    Set the entries in column number column 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
```
T[] getRow(int row)
    throws MathIllegalArgumentException
```
    Get the entries in row number row 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
```
void setRow(int row,
            T[] array)
     throws MathIllegalArgumentException
```
    Set the entries in row number row 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
```
T[] getColumn(int column)
       throws MathIllegalArgumentException
```
    Get the entries in column number col 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
```
void setColumn(int column,
               T[] array)
        throws MathIllegalArgumentException
```
    Set the entries in column number column as a column matrix.
    
    Parameters:
    
    column - the column to be set
    
    array - 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
```
T getEntry(int row,
           int column)
    throws MathIllegalArgumentException
```
    Returns the entry in the specified row and column.
    
    Parameters:
    
    row - row location of entry to be fetched
    
    column - 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
```
void setEntry(int row,
              int column,
              T value)
       throws MathIllegalArgumentException
```
    Set the entry in the specified row and column.
    
    Parameters:
    
    row - row location of entry to be set
    
    column - column location of entry to be set
    
    value - matrix entry to be set in row,column
    
    Throws:
    
    MathIllegalArgumentException - if the row or column index is not valid.
  - addToEntry
```
void addToEntry(int row,
                int column,
                T increment)
         throws MathIllegalArgumentException
```
    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
```
void multiplyEntry(int row,
                   int column,
                   T factor)
            throws MathIllegalArgumentException
```
    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
```
T getTrace()
    throws MathIllegalArgumentException
```
    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
```
T[] operate(T[] v)
     throws MathIllegalArgumentException
```
    Returns the result of multiplying this by the vector v.
    
    Parameters:
    
    v - the vector to operate on
    
    Returns:
    
    this * v
    
    Throws:
    
    MathIllegalArgumentException - if the number of columns of this matrix is not equal to the size of the vector v.
  - operate
```
FieldVector<T> operate(FieldVector<T> v)
                throws MathIllegalArgumentException
```
    Returns the result of multiplying this by the vector v.
    
    Parameters:
    
    v - the vector to operate on
    
    Returns:
    
    this * v
    
    Throws:
    
    MathIllegalArgumentException - if the number of columns of this matrix is not equal to the size of the vector v.
  - preMultiply
```
T[] preMultiply(T[] v)
         throws MathIllegalArgumentException
```
    Returns the (row) vector result of premultiplying this by the vector v.
    
    Parameters:
    
    v - the row vector to premultiply by
    
    Returns:
    
    v * this
    
    Throws:
    
    MathIllegalArgumentException - if the number of rows of this matrix is not equal to the size of the vector v
  - preMultiply
```
FieldVector<T> preMultiply(FieldVector<T> v)
                    throws MathIllegalArgumentException
```
    Returns the (row) vector result of premultiplying this by the vector v.
    
    Parameters:
    
    v - the row vector to premultiply by
    
    Returns:
    
    v * this
    
    Throws:
    
    MathIllegalArgumentException - if the number of rows of this matrix is not equal to the size of the vector v
  - walkInRowOrder
```
T walkInRowOrder(FieldMatrixChangingVisitor<T> visitor)
```
    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
```
T walkInRowOrder(FieldMatrixPreservingVisitor<T> visitor)
```
    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 entries
    
    startRow - Initial row index
    
    endRow - Final row index (inclusive)
    
    startColumn - Initial column index
    
    endColumn - 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 - if endRow < startRow or endColumn < 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 entries
    
    startRow - Initial row index
    
    endRow - Final row index (inclusive)
    
    startColumn - Initial column index
    
    endColumn - 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 - if endRow < startRow or endColumn < 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
```
T walkInColumnOrder(FieldMatrixChangingVisitor<T> visitor)
```
    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
```
T walkInColumnOrder(FieldMatrixPreservingVisitor<T> visitor)
```
    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 entries
    
    startRow - Initial row index
    
    endRow - Final row index (inclusive)
    
    startColumn - Initial column index
    
    endColumn - Final column index
    
    Returns:
    
    the value returned by FieldMatrixChangingVisitor.end() at the end of the walk
    
    Throws:
    
    MathIllegalArgumentException - if endRow < startRow or endColumn < 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 entries
    
    startRow - Initial row index
    
    endRow - Final row index (inclusive)
    
    startColumn - Initial column index
    
    endColumn - Final column index
    
    Returns:
    
    the value returned by FieldMatrixPreservingVisitor.end() at the end of the walk
    
    Throws:
    
    MathIllegalArgumentException - if endRow < startRow or endColumn < 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
```
T walkInOptimizedOrder(FieldMatrixChangingVisitor<T> visitor)
```
    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
```
T walkInOptimizedOrder(FieldMatrixPreservingVisitor<T> visitor)
```
    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 entries
    
    startRow - Initial row index
    
    endRow - Final row index (inclusive)
    
    startColumn - Initial column index
    
    endColumn - Final column index (inclusive)
    
    Returns:
    
    the value returned by FieldMatrixChangingVisitor.end() at the end of the walk
    
    Throws:
    
    MathIllegalArgumentException - if endRow < startRow or endColumn < 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 entries
    
    startRow - Initial row index
    
    endRow - Final row index (inclusive)
    
    startColumn - Initial column index
    
    endColumn - Final column index (inclusive)
    
    Returns:
    
    the value returned by FieldMatrixPreservingVisitor.end() at the end of the walk
    
    Throws:
    
    MathIllegalArgumentException - if endRow < startRow or endColumn < 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
```
default FieldMatrix<T> map(Function<T,T> function)
```
    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
```
default FieldMatrix<T> mapToSelf(Function<T,T> function)
```
    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

Interface FieldMatrix<T extends FieldElement<T>>

Method Summary

Methods inherited from interface org.hipparchus.linear.AnyMatrix

Method Detail

getField

createMatrix

copy

add

subtract

scalarAdd

scalarMultiply

multiply

multiplyTransposed

transposeMultiply

preMultiply

power

getData

getSubMatrix

getSubMatrix

copySubMatrix

copySubMatrix

setSubMatrix

getRowMatrix

setRowMatrix

getColumnMatrix

setColumnMatrix

getRowVector

setRowVector

getColumnVector

setColumnVector

getRow

setRow

getColumn

setColumn

getEntry

setEntry

addToEntry

multiplyEntry

transpose

getTrace

operate

operate

preMultiply

preMultiply

walkInRowOrder

walkInRowOrder

walkInRowOrder

walkInRowOrder

walkInColumnOrder

walkInColumnOrder

walkInColumnOrder

walkInColumnOrder

walkInOptimizedOrder

walkInOptimizedOrder

walkInOptimizedOrder

walkInOptimizedOrder

map

mapToSelf