Matrix.CreateHermitian Method

Definition

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

Overload List

CreateHermitian<T>(Int32) Constructs a new Hermitian matrix with the specified dimension.
CreateHermitian<T>(Int32, MatrixTriangle) Constructs a new Hermitian matrix with the specified dimension.
CreateHermitian<T>(Int32, T[], MatrixTriangle, MatrixElementOrder) Constructs a new Hermitian matrix of the specified dimension using the specified values.
CreateHermitian<T>(Int32, Array2D<T>, MatrixTriangle, MatrixElementOrder, ArrayMutability) Constructs a new Hermitian matrix of the specified dimension using the specified values.
CreateHermitian<T>(Int32, T[], MatrixTriangle, MatrixElementOrder, Boolean, ArrayMutability) Constructs a new symmetrical matrix of the specified dimension using the specified values.

CreateHermitian<T>(Int32)

Constructs a new Hermitian matrix with the specified dimension.
C#
public static HermitianMatrix<T> CreateHermitian<T>(
	int dimension
)

Parameters

dimension  Int32
The number of rows and columns in the new Hermitian matrix.

Type Parameters

T

Return Value

HermitianMatrix<T>
A Hermitian matrix.

CreateHermitian<T>(Int32, MatrixTriangle)

Constructs a new Hermitian matrix with the specified dimension.
C#
public static HermitianMatrix<T> CreateHermitian<T>(
	int dimension,
	MatrixTriangle storedTriangle
)

Parameters

dimension  Int32
The number of rows and columns Specifies whether the upper or lower triangle is stored. in the new Hermitian matrix.
storedTriangle  MatrixTriangle
 

Type Parameters

T

Return Value

HermitianMatrix<T>
A Hermitian matrix.

CreateHermitian<T>(Int32, T[], MatrixTriangle, MatrixElementOrder)

Constructs a new Hermitian matrix of the specified dimension using the specified values.
C#
public static HermitianMatrix<T> CreateHermitian<T>(
	int dimension,
	T[] values,
	MatrixTriangle matrixTriangle,
	MatrixElementOrder elementOrder
)

Parameters

dimension  Int32
The number of rows and columns in the new Hermitian matrix.
values  T[]
An Array of values containing the elements of the Hermitian matrix in column-major order
matrixTriangle  MatrixTriangle
A MatrixTriangle value that specifies whether to take the elements from the upper or lower triangle of the element values.
elementOrder  MatrixElementOrder
A MatrixElementOrder value that indicates whether the elements are stored in column-major or row-major order.

Type Parameters

T

Return Value

HermitianMatrix<T>
A Hermitian matrix.

Remarks

The array values must contain the elements of the matrix, column by column. Depending on the value of matrixTriangle, the values in the upper or lower triangular part of this array are used. The other elements must be present, but their value is irrelevant.

CreateHermitian<T>(Int32, Array2D<T>, MatrixTriangle, MatrixElementOrder, ArrayMutability)

Constructs a new Hermitian matrix of the specified dimension using the specified values.
C#
public static HermitianMatrix<T> CreateHermitian<T>(
	int dimension,
	Array2D<T> storage,
	MatrixTriangle storedTriangle,
	MatrixElementOrder elementOrder,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Parameters

dimension  Int32
The number of rows and columns in the new Hermitian matrix.
storage  Array2D<T>
A 2D array containing the elements of the Hermitian matrix in column-major order
storedTriangle  MatrixTriangle
A MatrixTriangle value that specifies whether to take the elements from the upper or lower triangle of the element values.
elementOrder  MatrixElementOrder
A MatrixElementOrder value that indicates whether the elements are stored in column-major or row-major order.
mutability  ArrayMutability  (Optional)
Specifies how the matrix's values may be changed. The default is mutable values.

Type Parameters

T

Return Value

HermitianMatrix<T>
A symmetric matrix.

Remarks

The array storage must contain the elements of the matrix, column by column. Depending on the value of storedTriangle, the values in the upper or lower triangular part of this array are used. The other elements must be present, but their value is irrelevant.

CreateHermitian<T>(Int32, T[], MatrixTriangle, MatrixElementOrder, Boolean, ArrayMutability)

Constructs a new symmetrical matrix of the specified dimension using the specified values.
C#
public static HermitianMatrix<T> CreateHermitian<T>(
	int dimension,
	T[] values,
	MatrixTriangle storedTriangle,
	MatrixElementOrder elementOrder,
	bool reuseComponentArray,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Parameters

dimension  Int32
The number of rows and columns in the new symmetric matrix.
values  T[]
An Array of values containing the elements of the symmetric matrix in column-major order
storedTriangle  MatrixTriangle
A MatrixTriangle value that specifies whether to take the elements from the upper or lower triangle of the element values.
elementOrder  MatrixElementOrder
A MatrixElementOrder value that indicates whether the elements are stored in column-major or row-major order.
reuseComponentArray  Boolean
A boolean value that indicates whether the values array should be copied or reused for internal storage.
mutability  ArrayMutability  (Optional)
Specifies how the matrix's values may be changed. The default is mutable values.

Type Parameters

T

Return Value

HermitianMatrix<T>
A symmetric matrix.

Remarks

The array values must contain the elements of the matrix, column by column. Depending on the value of storedTriangle, the values in the upper or lower triangular part of this array are used. The other elements must be present, but their value is irrelevant.

See Also