Matrix.CreateHermitian Method

public static HermitianMatrix<T> CreateHermitian<T>(
	int dimension
)

Public Shared Function CreateHermitian(Of T) ( 
	dimension As Integer
) As HermitianMatrix(Of T)

public:
generic<typename T>
static HermitianMatrix<T>^ CreateHermitian(
	int dimension
)

static member CreateHermitian : 
        dimension : int -> HermitianMatrix<'T> 

Parameters

dimension  Int32

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

Type Parameters

T

Return Value

public static HermitianMatrix<T> CreateHermitian<T>(
	int dimension,
	MatrixTriangle storedTriangle
)

Public Shared Function CreateHermitian(Of T) ( 
	dimension As Integer,
	storedTriangle As MatrixTriangle
) As HermitianMatrix(Of T)

public:
generic<typename T>
static HermitianMatrix<T>^ CreateHermitian(
	int dimension, 
	MatrixTriangle storedTriangle
)

static member CreateHermitian : 
        dimension : int * 
        storedTriangle : MatrixTriangle -> HermitianMatrix<'T> 

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

public static HermitianMatrix<T> CreateHermitian<T>(
	int dimension,
	T[] values,
	MatrixTriangle matrixTriangle,
	MatrixElementOrder elementOrder
)

Public Shared Function CreateHermitian(Of T) ( 
	dimension As Integer,
	values As T(),
	matrixTriangle As MatrixTriangle,
	elementOrder As MatrixElementOrder
) As HermitianMatrix(Of T)

public:
generic<typename T>
static HermitianMatrix<T>^ CreateHermitian(
	int dimension, 
	array<T>^ values, 
	MatrixTriangle matrixTriangle, 
	MatrixElementOrder elementOrder
)

static member CreateHermitian : 
        dimension : int * 
        values : 'T[] * 
        matrixTriangle : MatrixTriangle * 
        elementOrder : MatrixElementOrder -> HermitianMatrix<'T> 

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

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.

public static HermitianMatrix<T> CreateHermitian<T>(
	int dimension,
	Array2D<T> storage,
	MatrixTriangle storedTriangle,
	MatrixElementOrder elementOrder,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Public Shared Function CreateHermitian(Of T) ( 
	dimension As Integer,
	storage As Array2D(Of T),
	storedTriangle As MatrixTriangle,
	elementOrder As MatrixElementOrder,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As HermitianMatrix(Of T)

public:
generic<typename T>
static HermitianMatrix<T>^ CreateHermitian(
	int dimension, 
	Array2D<T> storage, 
	MatrixTriangle storedTriangle, 
	MatrixElementOrder elementOrder, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member CreateHermitian : 
        dimension : int * 
        storage : Array2D<'T> * 
        storedTriangle : MatrixTriangle * 
        elementOrder : MatrixElementOrder * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> HermitianMatrix<'T> 

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

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.

public static HermitianMatrix<T> CreateHermitian<T>(
	int dimension,
	T[] values,
	MatrixTriangle storedTriangle,
	MatrixElementOrder elementOrder,
	bool reuseComponentArray,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Public Shared Function CreateHermitian(Of T) ( 
	dimension As Integer,
	values As T(),
	storedTriangle As MatrixTriangle,
	elementOrder As MatrixElementOrder,
	reuseComponentArray As Boolean,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As HermitianMatrix(Of T)

public:
generic<typename T>
static HermitianMatrix<T>^ CreateHermitian(
	int dimension, 
	array<T>^ values, 
	MatrixTriangle storedTriangle, 
	MatrixElementOrder elementOrder, 
	bool reuseComponentArray, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member CreateHermitian : 
        dimension : int * 
        values : 'T[] * 
        storedTriangle : MatrixTriangle * 
        elementOrder : MatrixElementOrder * 
        reuseComponentArray : bool * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> HermitianMatrix<'T> 

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

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.

Reference