Class Array2DRowRealMatrix
- All Implemented Interfaces:
Serializable
,AnyMatrix
,RealMatrix
The LU decomposition is performed as needed, to support the following operations:
- solve
- isSingular
- getDeterminant
- inverse
Usage notes:
-
The LU decomposition is cached and reused on subsequent calls.
If data are modified via references to the underlying array obtained using
getDataRef()
, then the stored LU decomposition will not be discarded. In this case, you need to explicitly invokeLUDecompose()
to recompute the decomposition before using any of the methods above. -
As specified in the
RealMatrix
interface, matrix element indexing is 0-based -- e.g.,getEntry(0, 0)
returns the element in the first row, first column of the matrix.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a matrix with no dataArray2DRowRealMatrix
(double[] v) Create a new (column) RealMatrix usingv
as the data for the unique column of thev.length x 1
matrix created.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 TypeMethodDescriptionCompute the sum of this andm
.add
(RealMatrix m) Compute the sum of this and m.void
addToEntry
(int row, int column, double increment) Change an entry in the specified row and column.copy()
Returns a (deep) copy of this.createMatrix
(int rowDimension, int columnDimension) Create a new RealMatrix of the same type as the instance with the supplied row and column dimensions.int
Returns the number of columns in the matrix.double[][]
getData()
Returns matrix entries as a two-dimensional array.double[][]
Returns a reference to the underlying data array.double
getEntry
(int row, int column) Returns the entry in the specified row and column.int
Returns the number of rows in the matrix.Returns the result of postmultiplying this bym
.Returns the result of postmultiplying this by m.void
multiplyEntry
(int row, int column, double factor) Change an entry in the specified row and column.double[]
operate
(double[] v) Returns the result of multiplying this by the vectorv
.double[]
preMultiply
(double[] v) Returns the (row) vector result of premultiplying this by the vectorv
.void
setEntry
(int row, int column, double value) Set the entry in the specified row and column.void
setSubMatrix
(double[][] subMatrix, int row, int column) Replace the submatrix starting atrow, column
using data in the inputsubMatrix
array.Compute this minusm
.Compute this minus m.double
Visit (and possibly change) all matrix entries in column order.double
walkInColumnOrder
(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (and possibly change) some matrix entries in column order.double
Visit (but don't change) all matrix entries in column order.double
walkInColumnOrder
(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (but don't change) some matrix entries in column order.double
walkInRowOrder
(RealMatrixChangingVisitor visitor) Visit (and possibly change) all matrix entries in row order.double
walkInRowOrder
(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (and possibly change) some matrix entries in row order.double
Visit (but don't change) all matrix entries in row order.double
walkInRowOrder
(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) Visit (but don't change) some matrix entries in row order.Methods inherited from class org.apache.commons.math.linear.AbstractRealMatrix
copySubMatrix, copySubMatrix, equals, getColumn, getColumnMatrix, getColumnVector, getDeterminant, getFrobeniusNorm, getNorm, getRow, getRowMatrix, getRowVector, getSubMatrix, getSubMatrix, getTrace, hashCode, inverse, isSingular, isSquare, luDecompose, operate, preMultiply, preMultiply, scalarAdd, scalarMultiply, setColumn, setColumnMatrix, setColumnVector, setRow, setRowMatrix, setRowVector, solve, solve, toString, transpose, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder
-
Constructor Details
-
Array2DRowRealMatrix
public Array2DRowRealMatrix()Creates a matrix with no data -
Array2DRowRealMatrix
Create a new RealMatrix 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- Throws:
IllegalArgumentException
- if row or column dimension is not positive
-
Array2DRowRealMatrix
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 totrue
.- Parameters:
d
- data for new matrix- Throws:
IllegalArgumentException
- ifd
is not rectangular (not all rows have the same length) or emptyNullPointerException
- ifd
is null- See Also:
-
Array2DRowRealMatrix
public Array2DRowRealMatrix(double[][] d, boolean copyArray) throws IllegalArgumentException, NullPointerException 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 tofalseinvalid input: '<'/code. 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 matrixcopyArray
- if true, the input array will be copied, otherwise it will be referenced- Throws:
IllegalArgumentException
- ifd
is not rectangular (not all rows have the same length) or emptyNullPointerException
- ifd
is null- See Also:
-
Array2DRowRealMatrix
public Array2DRowRealMatrix(double[] v) Create a new (column) RealMatrix usingv
as the data for the unique column of thev.length x 1
matrix created.The input array is copied, not referenced.
- Parameters:
v
- column vector holding data for new matrix
-
-
Method Details
-
createMatrix
public RealMatrix createMatrix(int rowDimension, int columnDimension) throws IllegalArgumentException Create a new RealMatrix of the same type as the instance with the supplied row and column dimensions.- Specified by:
createMatrix
in interfaceRealMatrix
- Specified by:
createMatrix
in classAbstractRealMatrix
- 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:
IllegalArgumentException
- if row or column dimension is not positive
-
copy
Returns a (deep) copy of this.- Specified by:
copy
in interfaceRealMatrix
- Specified by:
copy
in classAbstractRealMatrix
- Returns:
- matrix copy
-
add
Compute the sum of this and m.- Specified by:
add
in interfaceRealMatrix
- Overrides:
add
in classAbstractRealMatrix
- Parameters:
m
- matrix to be added- Returns:
- this + m
- Throws:
IllegalArgumentException
- if m is not the same size as this
-
add
Compute the sum of this andm
.- Parameters:
m
- matrix to be added- Returns:
- this + m
- Throws:
IllegalArgumentException
- if m is not the same size as this
-
subtract
Compute this minus m.- Specified by:
subtract
in interfaceRealMatrix
- Overrides:
subtract
in classAbstractRealMatrix
- Parameters:
m
- matrix to be subtracted- Returns:
- this - m
- Throws:
IllegalArgumentException
- if m is not the same size as this
-
subtract
Compute this minusm
.- Parameters:
m
- matrix to be subtracted- Returns:
- this + m
- Throws:
IllegalArgumentException
- if m is not the same size as this
-
multiply
Returns the result of postmultiplying this by m.- Specified by:
multiply
in interfaceRealMatrix
- Overrides:
multiply
in classAbstractRealMatrix
- Parameters:
m
- matrix to postmultiply by- Returns:
- this * m
- Throws:
IllegalArgumentException
- if columnDimension(this) != rowDimension(m)
-
multiply
Returns the result of postmultiplying this bym
.- Parameters:
m
- matrix to postmultiply by- Returns:
- this*m
- Throws:
IllegalArgumentException
- if columnDimension(this) != rowDimension(m)
-
getData
public double[][] getData()Returns matrix entries as a two-dimensional array.- Specified by:
getData
in interfaceRealMatrix
- Overrides:
getData
in classAbstractRealMatrix
- Returns:
- 2-dimensional array of entries
-
getDataRef
public double[][] getDataRef()Returns a reference to the underlying data array.Does not make a fresh copy of the underlying data.
- Returns:
- 2-dimensional array of entries
-
setSubMatrix
Replace the submatrix starting atrow, 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
andsubMatrix = {{3, 4} {5,6}}
, invokingsetSubMatrix(subMatrix,1,1))
will result in1 2 3 4 5 3 4 8 9 5 6 2
- Specified by:
setSubMatrix
in interfaceRealMatrix
- Overrides:
setSubMatrix
in classAbstractRealMatrix
- Parameters:
subMatrix
- array containing the submatrix replacement datarow
- row coordinate of the top, left element to be replacedcolumn
- column coordinate of the top, left element to be replaced- Throws:
MatrixIndexException
- if subMatrix does not fit into this matrix from element in (row, column)
-
getEntry
Returns the entry in the specified row and column.Row and column indices start at 0 and must satisfy
0 invalid input: '<'= row invalid input: '<' rowDimension
0 invalid input: '<'= column invalid input: '<' columnDimension
MatrixIndexException
is thrown.- Specified by:
getEntry
in interfaceRealMatrix
- Specified by:
getEntry
in classAbstractRealMatrix
- Parameters:
row
- row location of entry to be fetchedcolumn
- column location of entry to be fetched- Returns:
- matrix entry in row,column
- Throws:
MatrixIndexException
- if the row or column index is not valid
-
setEntry
Set the entry in the specified row and column.Row and column indices start at 0 and must satisfy
0 invalid input: '<'= row invalid input: '<' rowDimension
0 invalid input: '<'= column invalid input: '<' columnDimension
MatrixIndexException
is thrown.- Specified by:
setEntry
in interfaceRealMatrix
- Specified by:
setEntry
in classAbstractRealMatrix
- 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:
MatrixIndexException
- if the row or column index is not valid
-
addToEntry
Change an entry in the specified row and column.Row and column indices start at 0 and must satisfy
0 invalid input: '<'= row invalid input: '<' rowDimension
0 invalid input: '<'= column invalid input: '<' columnDimension
MatrixIndexException
is thrown.- Specified by:
addToEntry
in interfaceRealMatrix
- Specified by:
addToEntry
in classAbstractRealMatrix
- Parameters:
row
- row location of entry to be setcolumn
- column location of entry to be setincrement
- value to add to the current matrix entry in row,column- Throws:
MatrixIndexException
- if the row or column index is not valid
-
multiplyEntry
Change an entry in the specified row and column.Row and column indices start at 0 and must satisfy
0 invalid input: '<'= row invalid input: '<' rowDimension
0 invalid input: '<'= column invalid input: '<' columnDimension
MatrixIndexException
is thrown.- Specified by:
multiplyEntry
in interfaceRealMatrix
- Specified by:
multiplyEntry
in classAbstractRealMatrix
- Parameters:
row
- row location of entry to be setcolumn
- column location of entry to be setfactor
- multiplication factor for the current matrix entry in row,column- Throws:
MatrixIndexException
- if the row or column index is not valid
-
getRowDimension
public int getRowDimension()Returns the number of rows in the matrix.- Specified by:
getRowDimension
in interfaceAnyMatrix
- Specified by:
getRowDimension
in classAbstractRealMatrix
- Returns:
- rowDimension
-
getColumnDimension
public int getColumnDimension()Returns the number of columns in the matrix.- Specified by:
getColumnDimension
in interfaceAnyMatrix
- Specified by:
getColumnDimension
in classAbstractRealMatrix
- Returns:
- columnDimension
-
operate
Returns the result of multiplying this by the vectorv
.- Specified by:
operate
in interfaceRealMatrix
- Overrides:
operate
in classAbstractRealMatrix
- Parameters:
v
- the vector to operate on- Returns:
- this*v
- Throws:
IllegalArgumentException
- if columnDimension != v.size()
-
preMultiply
Returns the (row) vector result of premultiplying this by the vectorv
.- Specified by:
preMultiply
in interfaceRealMatrix
- Overrides:
preMultiply
in classAbstractRealMatrix
- Parameters:
v
- the row vector to premultiply by- Returns:
- v*this
- Throws:
IllegalArgumentException
- if rowDimension != v.size()
-
walkInRowOrder
Visit (and possibly change) all matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrder
in interfaceRealMatrix
- Overrides:
walkInRowOrder
in classAbstractRealMatrix
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixChangingVisitor.end()
at the end of the walk - Throws:
MatrixVisitorException
- if the visitor cannot process an entry- See Also:
-
walkInRowOrder
Visit (but don't change) all matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrder
in interfaceRealMatrix
- Overrides:
walkInRowOrder
in classAbstractRealMatrix
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixPreservingVisitor.end()
at the end of the walk - Throws:
MatrixVisitorException
- if the visitor cannot process an entry- See Also:
-
walkInRowOrder
public double walkInRowOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException, MatrixVisitorException Visit (and possibly change) some matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrder
in interfaceRealMatrix
- Overrides:
walkInRowOrder
in classAbstractRealMatrix
- 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
RealMatrixChangingVisitor.end()
at the end of the walk - Throws:
MatrixIndexException
- if the indices are not validMatrixVisitorException
- if the visitor cannot process an entry- See Also:
-
walkInRowOrder
public double walkInRowOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException, MatrixVisitorException Visit (but don't change) some matrix entries in row order.Row order starts at upper left and iterating through all elements of a row from left to right before going to the leftmost element of the next row.
- Specified by:
walkInRowOrder
in interfaceRealMatrix
- Overrides:
walkInRowOrder
in classAbstractRealMatrix
- 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
RealMatrixPreservingVisitor.end()
at the end of the walk - Throws:
MatrixIndexException
- if the indices are not validMatrixVisitorException
- if the visitor cannot process an entry- See Also:
-
walkInColumnOrder
Visit (and possibly change) all matrix entries in column order.Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
- Specified by:
walkInColumnOrder
in interfaceRealMatrix
- Overrides:
walkInColumnOrder
in classAbstractRealMatrix
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixChangingVisitor.end()
at the end of the walk - Throws:
MatrixVisitorException
- if the visitor cannot process an entry- See Also:
-
walkInColumnOrder
Visit (but don't change) all matrix entries in column order.Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
- Specified by:
walkInColumnOrder
in interfaceRealMatrix
- Overrides:
walkInColumnOrder
in classAbstractRealMatrix
- Parameters:
visitor
- visitor used to process all matrix entries- Returns:
- the value returned by
RealMatrixPreservingVisitor.end()
at the end of the walk - Throws:
MatrixVisitorException
- if the visitor cannot process an entry- See Also:
-
walkInColumnOrder
public double walkInColumnOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException, MatrixVisitorException Visit (and possibly change) some matrix entries in column order.Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
- Specified by:
walkInColumnOrder
in interfaceRealMatrix
- Overrides:
walkInColumnOrder
in classAbstractRealMatrix
- 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
RealMatrixChangingVisitor.end()
at the end of the walk - Throws:
MatrixIndexException
- if the indices are not validMatrixVisitorException
- if the visitor cannot process an entry- See Also:
-
walkInColumnOrder
public double walkInColumnOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws MatrixIndexException, MatrixVisitorException Visit (but don't change) some matrix entries in column order.Column order starts at upper left and iterating through all elements of a column from top to bottom before going to the topmost element of the next column.
- Specified by:
walkInColumnOrder
in interfaceRealMatrix
- Overrides:
walkInColumnOrder
in classAbstractRealMatrix
- 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
RealMatrixPreservingVisitor.end()
at the end of the walk - Throws:
MatrixIndexException
- if the indices are not validMatrixVisitorException
- if the visitor cannot process an entry- See Also:
-