Class Array2DRowRealMatrix
- All Implemented Interfaces:
Serializable
,AnyMatrix
,RealMatrix
RealMatrix
using a double[][]
array to
store entries.- 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 the created matrix.Array2DRowRealMatrix
(double[][] d) Create a newRealMatrix
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 ofthis
andm
.void
addToEntry
(int row, int column, double increment) Adds (in place) the specified value to the specified entry ofthis
matrix.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 of this matrix.double[][]
getData()
Returns matrix entries as a two-dimensional array.double[][]
Get a reference to the underlying data array.double
getEntry
(int row, int column) Get the entry in the specified row and column.int
Returns the number of rows of this matrix.Returns the result of postmultiplyingthis
bym
.void
multiplyEntry
(int row, int column, double factor) Multiplies (in place) the specified entry ofthis
matrix by the specified value.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.Returnsthis
minusm
.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.math3.linear.AbstractRealMatrix
add, copySubMatrix, copySubMatrix, equals, getColumn, getColumnMatrix, getColumnVector, getFrobeniusNorm, getNorm, getRow, getRowMatrix, getRowVector, getSubMatrix, getSubMatrix, getTrace, hashCode, isSquare, multiply, operate, power, preMultiply, preMultiply, scalarAdd, scalarMultiply, setColumn, setColumnMatrix, setColumnVector, setRow, setRowMatrix, setRowVector, subtract, toString, transpose, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder, walkInOptimizedOrder
Methods inherited from class org.apache.commons.math3.linear.RealLinearOperator
isTransposable, operateTranspose
-
Constructor Details
-
Array2DRowRealMatrix
public Array2DRowRealMatrix()Creates a matrix with no data -
Array2DRowRealMatrix
public Array2DRowRealMatrix(int rowDimension, int columnDimension) throws NotStrictlyPositiveException 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) throws DimensionMismatchException, NoDataException, NullArgumentException Create a newRealMatrix
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 the new matrix.- Throws:
DimensionMismatchException
- ifd
is not rectangular.NoDataException
- ifd
row or column dimension is zero.NullArgumentException
- ifd
isnull
.- See Also:
-
Array2DRowRealMatrix
public Array2DRowRealMatrix(double[][] d, boolean copyArray) throws DimensionMismatchException, NoDataException, NullArgumentException 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, thecopyArray
may be set tofalse
. 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
- iftrue
, the input array will be copied, otherwise it will be referenced.- Throws:
DimensionMismatchException
- ifd
is not rectangular.NoDataException
- ifd
row or column dimension is zero.NullArgumentException
- ifd
isnull
.- See Also:
-
Array2DRowRealMatrix
public Array2DRowRealMatrix(double[] v) Create a new (column) RealMatrix usingv
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 Details
-
createMatrix
public RealMatrix createMatrix(int rowDimension, int columnDimension) throws NotStrictlyPositiveException 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:
NotStrictlyPositiveException
- 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 ofthis
andm
.- Parameters:
m
- Matrix to be added.- Returns:
this + m
.- Throws:
MatrixDimensionMismatchException
- ifm
is not the same size asthis
.
-
subtract
public Array2DRowRealMatrix subtract(Array2DRowRealMatrix m) throws MatrixDimensionMismatchException Returnsthis
minusm
.- Parameters:
m
- Matrix to be subtracted.- Returns:
this - m
- Throws:
MatrixDimensionMismatchException
- ifm
is not the same size asthis
.
-
multiply
Returns the result of postmultiplyingthis
bym
.- Parameters:
m
- matrix to postmultiply by- Returns:
this * m
- Throws:
DimensionMismatchException
- ifcolumnDimension(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()Get a reference to the underlying data array.- Returns:
- 2-dimensional array of entries.
-
setSubMatrix
public void setSubMatrix(double[][] subMatrix, int row, int column) throws NoDataException, OutOfRangeException, DimensionMismatchException, NullArgumentException 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:
NoDataException
- ifsubMatrix
is empty.OutOfRangeException
- ifsubMatrix
does not fit into this matrix from element in(row, column)
.DimensionMismatchException
- ifsubMatrix
is not rectangular (not all rows have the same length) or empty.NullArgumentException
- ifsubMatrix
isnull
.
-
getEntry
Get the entry in the specified row and column. Row and column indices start at 0.- Specified by:
getEntry
in interfaceRealMatrix
- Specified by:
getEntry
in classAbstractRealMatrix
- Parameters:
row
- Row index of entry to be fetched.column
- Column index of entry to be fetched.- Returns:
- the matrix entry at
(row, column)
. - Throws:
OutOfRangeException
- 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.- Specified by:
setEntry
in interfaceRealMatrix
- Specified by:
setEntry
in classAbstractRealMatrix
- Parameters:
row
- Row index of entry to be set.column
- Column index of entry to be set.value
- the new value of the entry.- Throws:
OutOfRangeException
- if the row or column index is not valid
-
addToEntry
Adds (in place) the specified value to the specified entry ofthis
matrix. Row and column indices start at 0.- Specified by:
addToEntry
in interfaceRealMatrix
- Overrides:
addToEntry
in classAbstractRealMatrix
- Parameters:
row
- Row index of the entry to be modified.column
- Column index of the entry to be modified.increment
- value to add to the matrix entry.- Throws:
OutOfRangeException
- if the row or column index is not valid.
-
multiplyEntry
Multiplies (in place) the specified entry ofthis
matrix by the specified value. Row and column indices start at 0.- Specified by:
multiplyEntry
in interfaceRealMatrix
- Overrides:
multiplyEntry
in classAbstractRealMatrix
- Parameters:
row
- Row index of the entry to be modified.column
- Column index of the entry to be modified.factor
- Multiplication factor for the matrix entry.- Throws:
OutOfRangeException
- if the row or column index is not valid.
-
getRowDimension
public int getRowDimension()Returns the number of rows of this matrix.- Specified by:
getRowDimension
in interfaceAnyMatrix
- Specified by:
getRowDimension
in classAbstractRealMatrix
- Returns:
- the number of rows.
-
getColumnDimension
public int getColumnDimension()Returns the number of columns of this matrix.- Specified by:
getColumnDimension
in interfaceAnyMatrix
- Specified by:
getColumnDimension
in classAbstractRealMatrix
- Returns:
- the number of columns.
-
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:
DimensionMismatchException
- if the length ofv
does not match the column dimension ofthis
.
-
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:
DimensionMismatchException
- if the length ofv
does not match the row dimension ofthis
.
-
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 - 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 - See Also:
-
walkInRowOrder
public double walkInRowOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException 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:
OutOfRangeException
- if the indices are not valid.NumberIsTooSmallException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
walkInRowOrder
public double walkInRowOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException 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:
OutOfRangeException
- if the indices are not valid.NumberIsTooSmallException
- ifendRow < startRow
orendColumn < startColumn
.- 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 - 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 - See Also:
-
walkInColumnOrder
public double walkInColumnOrder(RealMatrixChangingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException 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:
OutOfRangeException
- if the indices are not valid.NumberIsTooSmallException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-
walkInColumnOrder
public double walkInColumnOrder(RealMatrixPreservingVisitor visitor, int startRow, int endRow, int startColumn, int endColumn) throws OutOfRangeException, NumberIsTooSmallException 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:
OutOfRangeException
- if the indices are not valid.NumberIsTooSmallException
- ifendRow < startRow
orendColumn < startColumn
.- See Also:
-