Dense Matrix<T>.Extract Symmetric Method
Definition
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
Overload List
Extract | Creates a SymmetricMatrix<T> from a part of a DenseMatrix<T>. |
Extract | Creates a SymmetricMatrix<T> from a part of a DenseMatrix<T>. |
Extract | Creates a SymmetricMatrix<T> from a part of a matrix. |
ExtractSymmetric(MatrixTriangle, Boolean)
public SymmetricMatrix<T> ExtractSymmetric(
MatrixTriangle storedTriangle,
bool reuseValuesArray
)
Parameters
- storedTriangle MatrixTriangle
- A MatrixTriangle value that indicates whether the elements of the symmetric matrix are stored in the upper or lower triangular portion of the matrix.
- reuseValuesArray Boolean
- A boolean value that indicates whether the storage array used by the matrix should be copied or reused for internal storage.
Return Value
SymmetricMatrix<T>A SymmetricMatrix<T>.
Exceptions
Argument | the matrix is null. |
ExtractSymmetric(Int32, Int32, Int32, MatrixTriangle, Boolean)
public abstract SymmetricMatrix<T> ExtractSymmetric(
int dimension,
int startRow,
int startColumn,
MatrixTriangle storedTriangle,
bool reuseValuesArray
)
Parameters
- dimension Int32
- The number of rows and columns of the new matrix.
- startRow Int32
- The row in the matrix of the first element of the new matrix.
- startColumn Int32
- The column in the matrix of the first element of the new matrix.
- storedTriangle MatrixTriangle
- A MatrixTriangle value that indicates whether the elements of the symmetric matrix are stored in the upper or lower triangular portion of the block specified by startRow and startColumn.
- reuseValuesArray Boolean
- A boolean value that indicates whether the storage array used by the matrix should be copied or reused for internal storage.
Return Value
SymmetricMatrix<T>A SymmetricMatrix<T>.
Exceptions
Argument | the matrix is null. |
Argument | dimension is less than zero -or- startRow is less than zero or greater than or equal to the number of rows in the matrix. -or- startColumn is less than zero or greater than or equal to the number of columns in the matrix. |
Argument | startRow plus dimension is greater than or equal to the number of rows in the matrix. -or- startColumn plus dimension is greater than or equal to the number of columns in the matrix. |
ExtractSymmetric(Matrix<T>, Int32, Int32, Int32, MatrixTriangle)
public static SymmetricMatrix<T> ExtractSymmetric(
Matrix<T> matrix,
int dimension,
int startRow,
int startColumn,
MatrixTriangle storedTriangle
)
Parameters
- matrix Matrix<T>
- The matrix that contains the elements of the new matrix.
- dimension Int32
- The number of rows and columns of the new matrix.
- startRow Int32
- The row in matrix of the first element of the new matrix.
- startColumn Int32
- The column in matrix of the first element of the new matrix.
- storedTriangle MatrixTriangle
- A MatrixTriangle value that indicates whether the elements of the symmetric matrix are stored in the upper or lower triangular portion of the block specified by startRow and startColumn.
Return Value
SymmetricMatrix<T>A SymmetricMatrix<T>.
Exceptions
Argument | matrix is null. |
Argument | dimension is less than zero -or- startRow is less than zero or greater than or equal to the number of rows in matrix. -or- startColumn is less than zero or greater than or equal to the number of columns in matrix. |
Argument | startRow plus dimension is greater than or equal to the number of rows in matrix. -or- startColumn plus dimension is greater than or equal to the number of columns in matrix. |