Returns a sub-matrix of
this instance.
Namespace:
Extreme.Mathematics
Assembly:
Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
public virtual Matrix<T> GetSubmatrix(
int startRow,
int endRow,
int rowStride,
int startColumn,
int endColumn,
int columnStride,
TransposeOperation transposeOperation,
Intent intent = Intent.Inherit
)
Public Overridable Function GetSubmatrix (
startRow As Integer,
endRow As Integer,
rowStride As Integer,
startColumn As Integer,
endColumn As Integer,
columnStride As Integer,
transposeOperation As TransposeOperation,
Optional intent As Intent = Intent.Inherit
) As Matrix(Of T)
public:
virtual Matrix<T>^ GetSubmatrix(
int startRow,
int endRow,
int rowStride,
int startColumn,
int endColumn,
int columnStride,
TransposeOperation transposeOperation,
Intent intent = Intent::Inherit
)
abstract GetSubmatrix :
startRow : int *
endRow : int *
rowStride : int *
startColumn : int *
endColumn : int *
columnStride : int *
transposeOperation : TransposeOperation *
?intent : Intent
(* Defaults:
let _intent = defaultArg intent Intent.Inherit
*)
-> Matrix<'T>
override GetSubmatrix :
startRow : int *
endRow : int *
rowStride : int *
startColumn : int *
endColumn : int *
columnStride : int *
transposeOperation : TransposeOperation *
?intent : Intent
(* Defaults:
let _intent = defaultArg intent Intent.Inherit
*)
-> Matrix<'T>
Parameters
- startRow
- Type: SystemInt32
Index of the first row of the sub-matrix. - endRow
- Type: SystemInt32
Index of the last row of the sub-matrix. - rowStride
- Type: SystemInt32
The increment for the row index in the original matrix corresponding to an
increment of one in the row index of the new matrix. - startColumn
- Type: SystemInt32
Index of the first column of the sub-matrix. - endColumn
- Type: SystemInt32
Index of the last column of the sub-matrix. - columnStride
- Type: SystemInt32
The increment for the column index in the original matrix corresponding to an
increment of one in the column index of the new matrix. - transposeOperation
- Type: Extreme.MathematicsTransposeOperation
A TransposeOperation value
that specifies whether or not this view should show the
transpose of the matrix. - intent (Optional)
- Type: Extreme.MathematicsIntent
An Intent value that
specifies the intended use of the sub-matrix.
Return Value
Type:
MatrixTA
MatrixT that contains the
specified rows and columns.
Exception | Condition |
---|
ArgumentOutOfRangeException | startRow is less
than zero or greater than or equal to the number of rows. -or- endRow or endRow is less
than zero or greater than or equal to the number of rows. -or- startColumn is less
than zero or greater than or equal to the number of columns. -or- endColumn or endRow is less
than zero or greater than or equal to the number of columns. |
The matrix returned by this method is a view
on the original matrix. This means that any changes to the elements
of the return value will cause the corresponding elements in the
original matrix to change as well. Use the CloneData or
the ToDenseMatrix method on the return value to
create a matrix which has its own private element storage
independent from the original matrix.
Reference