fr.cnes.sirius.patrius.math.linear

Class Array2DRowRealMatrix

java.lang.Object

fr.cnes.sirius.patrius.math.linear.RealLinearOperator

fr.cnes.sirius.patrius.math.linear.AbstractRealMatrix

fr.cnes.sirius.patrius.math.linear.Array2DRowRealMatrix

All Implemented Interfaces:

AnyMatrix, RealMatrix, Serializable

public class Array2DRowRealMatrix
extends AbstractRealMatrix

Implementation of RealMatrix using a double[][] array to store entries.

Version:

$Id: Array2DRowRealMatrix.java 18108 2017-10-04 06:45:27Z bignon $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Array2DRowRealMatrix() Creates a matrix with no data
Array2DRowRealMatrix(double[] v) Create a new (column) RealMatrix using v as the data for the unique column of the created matrix.
Array2DRowRealMatrix(double[][] d) Create a new RealMatrix using the input array as the underlying data array.
Array2DRowRealMatrix(double[][] d, boolean copyArray) Create a new RealMatrix using the input array as the underlying data array.
Array2DRowRealMatrix(int rowDimension, int columnDimension) Create a new RealMatrix with the supplied row and column dimensions.

Method Summary

Modifier and Type	Method and Description
Array2DRowRealMatrix	add(Array2DRowRealMatrix m) Returns the result of adding a matrix M to this matrix.
void	addToEntry(int row, int column, double increment) Adds (in place) a given value to the specified entry of this matrix.
RealMatrix	copy() Returns a deep copy of this matrix.
void	copySubMatrix(int[] selectedRows, int[] selectedColumns, double[][] destination) Copies a submatrix into a given 2D array.
void	copySubMatrix(int startRow, int endRow, int startColumn, int endColumn, double[][] destination) Copies a submatrix into a given 2D array.
RealMatrix	createMatrix(int rowDimension, int columnDimension) Creates a new matrix of the same type as this matrix.
int	getColumnDimension() Returns the dimension of the domain of this operator.
double[][]	getData() Returns a 2D array containing the entries of the matrix.
double[][]	getData(boolean forceCopy) Returns a 2D array containing the entries of the matrix.
double[][]	getDataRef() Gets a direct reference to the underlying data array storing the entries of the matrix.
double	getEntry(int row, int column) Gets the entry at the specified row and column.
int	getRowDimension() Returns the dimension of the codomain of this operator.
RealMatrix	getSubMatrix(int[] selectedRows, int[] selectedColumns) Gets a submatrix.
RealMatrix	getSubMatrix(int startRow, int endRow, int startColumn, int endColumn) Gets a submatrix.
Array2DRowRealMatrix	multiply(Array2DRowRealMatrix m) Returns the result of postmultiplying this matrix by a matrix M.
Array2DRowRealMatrix	multiply(Array2DRowRealMatrix m, boolean toTranspose) Returns the result of postmultiplying this matrix by a matrix M or by its transpose MT.
Array2DRowRealMatrix	multiply(Array2DRowRealMatrix m, boolean toTranspose, double d) Returns the result of postmultiplying this matrix by a matrix M or by its transpose MT, then by a scalar d.
RealMatrix	multiply(RealMatrix m, boolean toTranspose, double d) Returns the result of postmultiplying this matrix by the matrix m or its transpose mT, then by the scalar d.
void	multiplyEntry(int row, int column, double factor) Multiplies (in place) the specified entry of this matrix by a given value.
double[]	operate(double[] v) Returns the result of postmultiplying this matrix by the vector v.
double[]	preMultiply(double[] v) Returns the result of premultiplying this matrix by the vector v.
void	setEntry(int row, int column, double value) Sets the entry at the specified row and column to a new value.
void	setSubMatrix(double[][] subMatrix, int row, int column) Replaces part of the matrix with a given submatrix, starting at the specified row and column.
Array2DRowRealMatrix	subtract(Array2DRowRealMatrix m) Returns the result of subtracting a matrix M from this matrix.
RealMatrix	transpose() Returns the transpose of this matrix.
double	walkInColumnOrder(RealMatrixChangingVisitor visitor) Visits (and possibly change) all matrix entries in column order.
double	walkInColumnOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) Visits (and possibly change) some matrix entries in column order.
double	walkInColumnOrder(RealMatrixPreservingVisitor visitor) Visits (but don't change) all matrix entries in column order.
double	walkInColumnOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) Visits (but don't change) some matrix entries in column order.
double	walkInRowOrder(RealMatrixChangingVisitor visitor) Visits (and possibly change) all matrix entries in row order.
double	walkInRowOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) Visits (and possibly change) some matrix entries in row order.
double	walkInRowOrder(RealMatrixPreservingVisitor visitor) Visits (but don't change) all matrix entries in row order.
double	walkInRowOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) Visits (but don't change) some matrix entries in row order.

Methods inherited from class fr.cnes.sirius.patrius.math.linear.AbstractRealMatrix

add, checkDestinationArray, checkSquare, concatenateDiagonally, concatenateDiagonally, concatenateDiagonally, concatenateHorizontally, concatenateHorizontally, concatenateVertically, concatenateVertically, copySubMatrix, copySubMatrix, equals, equals, getAbs, getColumn, getColumnMatrix, getColumnVector, getDefaultDecomposition, getDiagonal, getFrobeniusNorm, getInverse, getInverse, getMax, getMin, getNorm, getRow, getRowMatrix, getRowVector, getTrace, hashCode, isAntisymmetric, isDiagonal, isInvertible, isOrthogonal, isSquare, isSymmetric, isSymmetric, isSymmetric, multiply, multiply, multiply, operate, power, preMultiply, preMultiply, scalarAdd, scalarMultiply, setColumn, setColumnMatrix, setColumnVector, setDefaultDecomposition, setRow, setRowMatrix, setRowVector, subtract, toString, toString, transpose, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder

Methods inherited from class fr.cnes.sirius.patrius.math.linear.RealLinearOperator

isTransposable, operateTranspose

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface fr.cnes.sirius.patrius.math.linear.RealMatrix

getMax, getMin

Constructor Detail

Array2DRowRealMatrix

public Array2DRowRealMatrix()

Creates a matrix with no data

Array2DRowRealMatrix

public Array2DRowRealMatrix(int rowDimension,
                            int columnDimension)

Create a new RealMatrix with the supplied row and column dimensions.

Parameters:

rowDimension - Number of rows in the new matrix

columnDimension - Number of columns in the new matrix

Throws:

NotStrictlyPositiveException - if the row or column dimension is not positive

Array2DRowRealMatrix

public Array2DRowRealMatrix(double[][] d)

Create a new RealMatrix using the input array as the underlying data array.

The input array is copied, not referenced. This constructor has the same effect as calling Array2DRowRealMatrix(double[][], boolean) with the second argument set to true.

Parameters:

d - Data for the new matrix

Throws:

DimensionMismatchException - if d is not rectangular

NoDataException - if d row or column dimension is zero

NullArgumentException - if d is null

See Also:

Array2DRowRealMatrix(double[][], boolean)

Array2DRowRealMatrix

public Array2DRowRealMatrix(double[][] d,
                            boolean copyArray)

Create a new RealMatrix using the input array as the underlying data array. If an array is built specially in order to be embedded in a RealMatrix and not used directly, the copyArray may be set to false. This will prevent the copying and improve performance as no new array will be built and no data will be copied.

Parameters:

d - Data for new matrix

copyArray - if true, the input array will be copied, otherwise it will be referenced.

Throws:

DimensionMismatchException - if d is not rectangular

NoDataException - if d row or column dimension is zero

NullArgumentException - if d is null

See Also:

Array2DRowRealMatrix(double[][])

Array2DRowRealMatrix

public Array2DRowRealMatrix(double[] v)

Create a new (column) RealMatrix using v as the data for the unique column of the created matrix. The input array is copied.

Parameters:

v - Column vector holding data for new matrix

Method Detail

createMatrix

public RealMatrix createMatrix(int rowDimension,
                               int columnDimension)

Creates a new matrix of the same type as this matrix.

The returned matrix is filled with zeros. Its size is determined by the specified row and column dimensions, which must both be strictly positive. Additional constraints on the dimensions may apply depending on the implementation (for example, symmetric matrices must be square, which implies that the row and column dimensions must be equal).

Specified by:

createMatrix in interface RealMatrix

Specified by:

createMatrix in class AbstractRealMatrix

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 this matrix

copy

public RealMatrix copy()

Returns a deep copy of this matrix.

Specified by:

copy in interface RealMatrix

Specified by:

copy in class AbstractRealMatrix

Returns:

a deep copy of this matrix

add

public Array2DRowRealMatrix add(Array2DRowRealMatrix m)

Returns the result of adding a matrix M to this matrix.

Parameters:

m - the matrix M to be added

Returns:

the matrix resulting from the sum this + M

Throws:

MatrixDimensionMismatchException - if the matrix M is not the same size as this matrix

subtract

public Array2DRowRealMatrix subtract(Array2DRowRealMatrix m)

Returns the result of subtracting a matrix M from this matrix.

Parameters:

m - matrix to be subtracted

Returns:

the matrix resulting from the subtraction this - M

Throws:

MatrixDimensionMismatchException - if the matrix M is not the same size as this matrix

multiply

public RealMatrix multiply(RealMatrix m,
                           boolean toTranspose,
                           double d)

Returns the result of postmultiplying this matrix by the matrix m or its transpose m^T, then by the scalar d.

Specified by:

multiply in interface RealMatrix

Overrides:

multiply in class AbstractRealMatrix

Parameters:

m - the matrix by which to multiply this matrix by

toTranspose - whether to compute the product this×m×d ( toTranspose=false), or the product this×m ^T×d (toTranspose=true)

d - the scalar by which to multiply the resulting matrix by

Returns:

the matrix resulting from the product this×m×d or this×m^T×d

multiply

public Array2DRowRealMatrix multiply(Array2DRowRealMatrix m)

Returns the result of postmultiplying this matrix by a matrix M.

Parameters:

m - the matrix M by which to multiply this matrix by

Returns:

the matrix resulting from the product this × M

Throws:

DimensionMismatchException - if the matrices are not multiplication compatible

multiply

public Array2DRowRealMatrix multiply(Array2DRowRealMatrix m,
                                     boolean toTranspose)

Returns the result of postmultiplying this matrix by a matrix M or by its transpose M^T.

Parameters:

m - the matrix M by which to multiply this matrix by

toTranspose - whether to compute the product this × M (toTranspose=false), or the product this × M^T (toTranspose=true)

Returns:

the matrix resulting from the product this × M or this × M^T

Throws:

DimensionMismatchException - if the matrices are not multiplication compatible

multiply

public Array2DRowRealMatrix multiply(Array2DRowRealMatrix m,
                                     boolean toTranspose,
                                     double d)

Returns the result of postmultiplying this matrix by a matrix M or by its transpose M^T, then by a scalar d.

Parameters:

m - the matrix M by which to multiply this matrix by

toTranspose - whether to compute the product this × M ×d ( toTranspose=false), or the product this × M^T × d (toTranspose=true)

d - the scalar by which to multiply the resulting matrix by

Returns:

the matrix resulting from the product this × M × d or this × M^T × d

Throws:

DimensionMismatchException - if the matrices are not multiplication compatible

getData

public double[][] getData()

Returns a 2D array containing the entries of the matrix.

Specified by:

getData in interface RealMatrix

Overrides:

getData in class AbstractRealMatrix

Returns:

a 2D array containing the entries of the matrix

getData

public double[][] getData(boolean forceCopy)

Returns a 2D array containing the entries of the matrix.

If forceCopy is true, the returned array is guaranteed to be free of references to any internal data array (thus, can be safely modified). Otherwise, the returned array may contain references to internal data arrays (for optimization purposes). Note that setting forceCopy to false does not guarantee the returned array references an internal data array. For instance, implementations that do not store the entries of the matrix in a 2D array have to rebuild a new array each time this method is called, regardless of this parameter.

Specified by:

getData in interface RealMatrix

Overrides:

getData in class AbstractRealMatrix

Parameters:

forceCopy - if true, the entries of the matrix are systematically stored in a new array; otherwise the returned array may reference internal data arrays

Returns:

a 2D array containing entries of the matrix

getDataRef

public double[][] getDataRef()

Gets a direct reference to the underlying data array storing the entries of the matrix.

Returns:

the underlying data array storing the entries of the matrix

setSubMatrix

public void setSubMatrix(double[][] subMatrix,
                         int row,
                         int column)

Replaces part of the matrix with a given submatrix, starting at the specified row and column.

Rows and columns are indicated counting from 0 to n-1.

Usage example:

 // Initial matrix
 matrix = [a00, a10, a20]
          [a10, a11, a21]
          [a20, a21, a22]
 // Submatrix
 subMatrix = [b00, b01]
             [b10, b11]
            
 // Replace part of the initial matrix 
 matrix.setSubMatrix(subMatrix, 1, 1) =>[a00, a10, a20]
                                        [a10, b00, b01]
                                        [a20, b10, b11]
 

Specified by:

setSubMatrix in interface RealMatrix

Overrides:

setSubMatrix in class AbstractRealMatrix

Parameters:

subMatrix - the array containing the submatrix replacement data

row - the row coordinate of the top, left element to be replaced

column - the column coordinate of the top, left element to be replaced

getSubMatrix

public RealMatrix getSubMatrix(int startRow,
                               int endRow,
                               int startColumn,
                               int endColumn)

Gets a submatrix.

Rows and columns are indicated counting from 0 to n-1.

Specified by:

getSubMatrix in interface RealMatrix

Overrides:

getSubMatrix in class AbstractRealMatrix

Parameters:

startRow - the initial row index

endRow - the final row index (inclusive)

startColumn - the initial column index

endColumn - the final column index (inclusive)

Returns:

the submatrix containing the data of the specified rows and columns

getSubMatrix

public RealMatrix getSubMatrix(int[] selectedRows,
                               int[] selectedColumns)

Gets a submatrix.

Rows and columns are indicated counting from 0 to n-1.

Specified by:

getSubMatrix in interface RealMatrix

Overrides:

getSubMatrix in class AbstractRealMatrix

Parameters:

selectedRows - the selected row indices

selectedColumns - the selected column indices

Returns:

the submatrix containing the data in the specified rows and columns

copySubMatrix

public void copySubMatrix(int startRow,
                          int endRow,
                          int startColumn,
                          int endColumn,
                          double[][] destination)

Copies a submatrix into a given 2D array.

Rows and columns are indicated counting from 0 to n-1. The submatrix data is copied in the upper-left part of the destination array. Elements which are not overwritten by the submatrix data are left unchanged (for example, if the destination array is larger than the size of the extracted submatrix).

Specified by:

copySubMatrix in interface RealMatrix

Overrides:

copySubMatrix in class AbstractRealMatrix

Parameters:

startRow - the initial row index

endRow - the final row index (inclusive)

startColumn - the initial column index

endColumn - the final column index (inclusive)

destination - the 2D array where the submatrix data should be copied

copySubMatrix

public void copySubMatrix(int[] selectedRows,
                          int[] selectedColumns,
                          double[][] destination)

Copies a submatrix into a given 2D array.

Rows and columns are indicated counting from 0 to n-1. The submatrix data is copied in the upper-left part of the destination array. Elements which are not overwritten by the submatrix data are left unchanged (for example, if the destination array is larger than the size of the extracted submatrix).

Specified by:

copySubMatrix in interface RealMatrix

Overrides:

copySubMatrix in class AbstractRealMatrix

Parameters:

selectedRows - the selected row indices

selectedColumns - the selected column indices

destination - the 2D array where the submatrix data should be copied

getEntry

public double getEntry(int row,
                       int column)

Gets the entry at the specified row and column.

Row and column indices start at 0.

Specified by:

getEntry in interface RealMatrix

Specified by:

getEntry in class AbstractRealMatrix

Parameters:

row - the row index of entry to be fetched

column - the column index of entry to be fetched

Returns:

the matrix entry at the specified row and column

setEntry

public void setEntry(int row,
                     int column,
                     double value)

Sets the entry at the specified row and column to a new value.

Row and column indices start at 0.

Specified by:

setEntry in interface RealMatrix

Specified by:

setEntry in class AbstractRealMatrix

Parameters:

row - the row index of entry to be set

column - the column index of entry to be set

value - the new value of the entry

addToEntry

public void addToEntry(int row,
                       int column,
                       double increment)

Adds (in place) a given value to the specified entry of this matrix.

Row and column indices start at 0.

Specified by:

addToEntry in interface RealMatrix

Overrides:

addToEntry in class AbstractRealMatrix

Parameters:

row - the row index of the entry to be modified

column - the column index of the entry to be modified

increment - the value to add to the matrix entry

multiplyEntry

public void multiplyEntry(int row,
                          int column,
                          double factor)

Multiplies (in place) the specified entry of this matrix by a given value.

Row and column indices start at 0.

Specified by:

multiplyEntry in interface RealMatrix

Overrides:

multiplyEntry in class AbstractRealMatrix

Parameters:

row - the row index of the entry to be modified

column - the column index of the entry to be modified

factor - the multiplication factor for the matrix entry

getRowDimension

public int getRowDimension()

Returns the dimension of the codomain of this operator.

Specified by:

getRowDimension in interface AnyMatrix

Specified by:

getRowDimension in class AbstractRealMatrix

Returns:

the number of rows of the underlying matrix

getColumnDimension

public int getColumnDimension()

Returns the dimension of the domain of this operator.

Specified by:

getColumnDimension in interface AnyMatrix

Specified by:

getColumnDimension in class AbstractRealMatrix

Returns:

the number of columns of the underlying matrix

operate

public double[] operate(double[] v)

Returns the result of postmultiplying this matrix by the vector v.

Specified by:

operate in interface RealMatrix

Overrides:

operate in class AbstractRealMatrix

Parameters:

v - the vector by which to multiply this matrix by

Returns:

the column vector resulting from the product this×v

preMultiply

public double[] preMultiply(double[] v)

Returns the result of premultiplying this matrix by the vector v.

Specified by:

preMultiply in interface RealMatrix

Overrides:

preMultiply in class AbstractRealMatrix

Parameters:

v - the row vector by which to premultiply this matrix by

Returns:

the row vector resulting from the product v×this

walkInRowOrder

public double walkInRowOrder(RealMatrixChangingVisitor visitor)

Visits (and possibly change) all matrix entries in row order.

Row order starts at upper left element, 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 interface RealMatrix

Overrides:

walkInRowOrder in class AbstractRealMatrix

Parameters:

visitor - the visitor used to process all matrix entries

Returns:

the value returned by RealMatrixChangingVisitor.end() at the end of the walk

See Also:

RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor), RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)

walkInRowOrder

public double walkInRowOrder(RealMatrixPreservingVisitor visitor)

Visits (but don't change) all matrix entries in row order.

Row order starts at upper left element, 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 interface RealMatrix

Overrides:

walkInRowOrder in class AbstractRealMatrix

Parameters:

visitor - the visitor used to process all matrix entries

Returns:

the value returned by RealMatrixPreservingVisitor.end() at the end of the walk

See Also:

RealMatrix.walkInRowOrder(RealMatrixChangingVisitor), RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)

walkInRowOrder

public double walkInRowOrder(RealMatrixChangingVisitor visitor,
                             int startRow,
                             int endRow,
                             int startColumn,
                             int endColumn)

Visits (and possibly change) some matrix entries in row order.

Row order starts at upper left element, 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 interface RealMatrix

Overrides:

walkInRowOrder in class AbstractRealMatrix

Parameters:

visitor - the visitor used to process all matrix entries

startRow - the initial row index

endRow - the final row index (inclusive)

startColumn - the initial column index

endColumn - the final column index

Returns:

the value returned by RealMatrixChangingVisitor.end() at the end of the walk

See Also:

RealMatrix.walkInRowOrder(RealMatrixChangingVisitor), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)

walkInRowOrder

public double walkInRowOrder(RealMatrixPreservingVisitor visitor,
                             int startRow,
                             int endRow,
                             int startColumn,
                             int endColumn)

Visits (but don't change) some matrix entries in row order.

Row order starts at upper left element, 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 interface RealMatrix

Overrides:

walkInRowOrder in class AbstractRealMatrix

Parameters:

visitor - the visitor used to process all matrix entries

startRow - the initial row index

endRow - the final row index (inclusive)

startColumn - the initial column index

endColumn - the final column index

Returns:

the value returned by RealMatrixPreservingVisitor.end() at the end of the walk

See Also:

RealMatrix.walkInRowOrder(RealMatrixChangingVisitor), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor), RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)

walkInColumnOrder

public double walkInColumnOrder(RealMatrixChangingVisitor visitor)

Visits (and possibly change) all matrix entries in column order.

Column order starts at upper left element, 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 interface RealMatrix

Overrides:

walkInColumnOrder in class AbstractRealMatrix

Parameters:

visitor - the visitor used to process all matrix entries

Returns:

the value returned by RealMatrixChangingVisitor.end() at the end of the walk

See Also:

RealMatrix.walkInRowOrder(RealMatrixChangingVisitor), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor), RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)

walkInColumnOrder

public double walkInColumnOrder(RealMatrixPreservingVisitor visitor)

Visits (but don't change) all matrix entries in column order.

Column order starts at upper left element, 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 interface RealMatrix

Overrides:

walkInColumnOrder in class AbstractRealMatrix

Parameters:

visitor - the visitor used to process all matrix entries

Returns:

the value returned by RealMatrixPreservingVisitor.end() at the end of the walk

See Also:

RealMatrix.walkInRowOrder(RealMatrixChangingVisitor), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor), RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)

walkInColumnOrder

public double walkInColumnOrder(RealMatrixChangingVisitor visitor,
                                int startRow,
                                int endRow,
                                int startColumn,
                                int endColumn)

Visits (and possibly change) some matrix entries in column order.

Column order starts at upper left element, 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 interface RealMatrix

Overrides:

walkInColumnOrder in class AbstractRealMatrix

Parameters:

visitor - the visitor used to process all matrix entries

startRow - the initial row index

endRow - the final row index (inclusive)

startColumn - the initial column index

endColumn - the final column index

Returns:

the value returned by RealMatrixChangingVisitor.end() at the end of the walk

See Also:

RealMatrix.walkInRowOrder(RealMatrixChangingVisitor), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor), RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)

walkInColumnOrder

public double walkInColumnOrder(RealMatrixPreservingVisitor visitor,
                                int startRow,
                                int endRow,
                                int startColumn,
                                int endColumn)

Visits (but don't change) some matrix entries in column order.

Column order starts at upper left element, 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 interface RealMatrix

Overrides:

walkInColumnOrder in class AbstractRealMatrix

Parameters:

visitor - the visitor used to process all matrix entries

startRow - the initial row index

endRow - the final row index (inclusive)

startColumn - the initial column index

endColumn - the final column index

Returns:

the value returned by RealMatrixPreservingVisitor.end() at the end of the walk

See Also:

RealMatrix.walkInRowOrder(RealMatrixChangingVisitor), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor), RealMatrix.walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor), RealMatrix.walkInColumnOrder(RealMatrixPreservingVisitor), RealMatrix.walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor), RealMatrix.walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int), RealMatrix.walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)

transpose

public final RealMatrix transpose()

Returns the transpose of this matrix.

Specified by:

transpose in interface RealMatrix

Overrides:

transpose in class AbstractRealMatrix

Returns:

the transpose of this matrix