HermitianMatrix<T>.Extract Method

Definition

Namespace: Extreme.Mathematics.LinearAlgebra
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

Extract(DenseMatrix<T>, MatrixTriangle, Boolean)

Creates a HermitianMatrix<T> from a part of a DenseMatrix<T>.
C#
public static HermitianMatrix<T> Extract(
	DenseMatrix<T> matrix,
	MatrixTriangle storedTriangle,
	bool reuseComponentArray
)

Parameters

matrix  DenseMatrix<T>
The matrix that contains the components of the new matrix.
storedTriangle  MatrixTriangle
A MatrixTriangle value that indicates whether the components of the Hermitian matrix are stored in the upper or lower triangular portion of the matrix.
reuseComponentArray  Boolean
A boolean value that indicates whether the storage array used by matrix should be copied or reused for internal storage.

Return Value

HermitianMatrix<T>
A HermitianMatrix<T>.

Exceptions

ArgumentNullExceptionmatrix is null.

Extract(Matrix<T>, Int32, Int32, Int32, MatrixTriangle)

Creates a HermitianMatrix<T> from a part of a matrix.
C#
public static HermitianMatrix<T> Extract(
	Matrix<T> matrix,
	int dimension,
	int startRow,
	int startColumn,
	MatrixTriangle storedTriangle
)

Parameters

matrix  Matrix<T>
The matrix that contains the components 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 component of the new matrix.
startColumn  Int32
The column in matrix of the first component of the new matrix.
storedTriangle  MatrixTriangle
A MatrixTriangle value that indicates whether the components of the Hermitian matrix are stored in the upper or lower triangular portion of the block specified by startRow and startColumn.

Return Value

HermitianMatrix<T>
A HermitianMatrix<T>.

Exceptions

ArgumentNullExceptionmatrix is null.
ArgumentOutOfRangeExceptiondimension 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.

ArgumentException

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.

Extract(DenseMatrix<T>, Int32, Int32, Int32, MatrixTriangle, Boolean)

Creates a HermitianMatrix<T> from a part of a DenseMatrix<T>.
C#
public static HermitianMatrix<T> Extract(
	DenseMatrix<T> matrix,
	int dimension,
	int startRow,
	int startColumn,
	MatrixTriangle matrixTriangle,
	bool reuseComponentArray
)

Parameters

matrix  DenseMatrix<T>
The matrix that contains the components 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 component of the new matrix.
startColumn  Int32
The column in matrix of the first component of the new matrix.
matrixTriangle  MatrixTriangle
A MatrixTriangle value that indicates whether the components of the Hermitian matrix are stored in the upper or lower triangular portion of the block specified by startRow and startColumn.
reuseComponentArray  Boolean
A boolean value that indicates whether the storage array used by matrix should be copied or reused for internal storage.

Return Value

HermitianMatrix<T>
A HermitianMatrix<T>.

Exceptions

ArgumentNullExceptionmatrix is null.
ArgumentOutOfRangeExceptiondimension 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.

ArgumentException

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.

See Also