Matrix.WrapSymmetric Method

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.0.0

Overload List

WrapSymmetric<T>(Array2D<T>, Int32, MatrixTriangle, MatrixElementOrder, ArrayMutability)	Creates a new SymmetricMatrix<T> by wrapping an existing Array2D<T> without copying.
WrapSymmetric<T>(T[], Int32, MatrixTriangle, MatrixElementOrder, ArrayMutability)	Creates a new SymmetricMatrix<T> by wrapping an existing one-dimensional array without copying.
WrapSymmetric<T>(Memory2D<T>, Int32, MatrixTriangle, MatrixElementOrder, ArrayMutability)	Creates a new SymmetricMatrix<T> by wrapping an existing Memory2D<T> without copying.

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

Creates a new SymmetricMatrix<T> by wrapping an existing Array2D<T> without copying.

public static SymmetricMatrix<T> WrapSymmetric<T>(
	Array2D<T> source,
	int dimension,
	MatrixTriangle storedTriangle = MatrixTriangle.Upper,
	MatrixElementOrder elementOrder = MatrixElementOrder.ColumnMajor,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function WrapSymmetric(Of T) ( 
	source As Array2D(Of T),
	dimension As Integer,
	Optional storedTriangle As MatrixTriangle = MatrixTriangle.Upper,
	Optional elementOrder As MatrixElementOrder = MatrixElementOrder.ColumnMajor,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As SymmetricMatrix(Of T)

C++/CLI

public:
generic<typename T>
static SymmetricMatrix<T>^ WrapSymmetric(
	Array2D<T> source, 
	int dimension, 
	MatrixTriangle storedTriangle = MatrixTriangle::Upper, 
	MatrixElementOrder elementOrder = MatrixElementOrder::ColumnMajor, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member WrapSymmetric : 
        source : Array2D<'T> * 
        dimension : int * 
        ?storedTriangle : MatrixTriangle * 
        ?elementOrder : MatrixElementOrder * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _storedTriangle = defaultArg storedTriangle MatrixTriangle.Upper
        let _elementOrder = defaultArg elementOrder MatrixElementOrder.ColumnMajor
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> SymmetricMatrix<'T>

Parameters

source Array2D<T>: An Array2D<T> to wrap.
dimension Int32: The number of rows and columns in the symmetric matrix.
storedTriangle MatrixTriangle (Optional): Specifies whether the upper or lower triangle is stored.
elementOrder MatrixElementOrder (Optional): 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: The element type of the matrix.

Return Value

SymmetricMatrix<T>
A new SymmetricMatrix<T> that wraps the source storage.

Remarks

Changes to the matrix will affect the original storage, and vice versa.

Exceptions

ArgumentNullException

source is null.

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

Creates a new SymmetricMatrix<T> by wrapping an existing one-dimensional array without copying.

public static SymmetricMatrix<T> WrapSymmetric<T>(
	T[] source,
	int dimension,
	MatrixTriangle storedTriangle = MatrixTriangle.Upper,
	MatrixElementOrder elementOrder = MatrixElementOrder.ColumnMajor,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function WrapSymmetric(Of T) ( 
	source As T(),
	dimension As Integer,
	Optional storedTriangle As MatrixTriangle = MatrixTriangle.Upper,
	Optional elementOrder As MatrixElementOrder = MatrixElementOrder.ColumnMajor,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As SymmetricMatrix(Of T)

C++/CLI

public:
generic<typename T>
static SymmetricMatrix<T>^ WrapSymmetric(
	array<T>^ source, 
	int dimension, 
	MatrixTriangle storedTriangle = MatrixTriangle::Upper, 
	MatrixElementOrder elementOrder = MatrixElementOrder::ColumnMajor, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member WrapSymmetric : 
        source : 'T[] * 
        dimension : int * 
        ?storedTriangle : MatrixTriangle * 
        ?elementOrder : MatrixElementOrder * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _storedTriangle = defaultArg storedTriangle MatrixTriangle.Upper
        let _elementOrder = defaultArg elementOrder MatrixElementOrder.ColumnMajor
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> SymmetricMatrix<'T>

Parameters

source T[]: A one-dimensional array to wrap.
dimension Int32: The number of rows and columns in the symmetric matrix.
storedTriangle MatrixTriangle (Optional): Specifies whether the upper or lower triangle is stored in source.
elementOrder MatrixElementOrder (Optional): A MatrixElementOrder value that indicates whether the elements in source 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: The element type of the matrix.

Return Value

SymmetricMatrix<T>
A new SymmetricMatrix<T> that wraps the source array.

Remarks

Changes to the matrix will affect the original array, and vice versa.

Exceptions

ArgumentNullException	source is null.
ArgumentException	The length of source is less than dimension * dimension.

WrapSymmetric<T>(Memory2D<T>, Int32, MatrixTriangle, MatrixElementOrder, ArrayMutability)

Creates a new SymmetricMatrix<T> by wrapping an existing Memory2D<T> without copying.

public static SymmetricMatrix<T> WrapSymmetric<T>(
	Memory2D<T> source,
	int dimension,
	MatrixTriangle storedTriangle = MatrixTriangle.Upper,
	MatrixElementOrder elementOrder = MatrixElementOrder.ColumnMajor,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function WrapSymmetric(Of T) ( 
	source As Memory2D(Of T),
	dimension As Integer,
	Optional storedTriangle As MatrixTriangle = MatrixTriangle.Upper,
	Optional elementOrder As MatrixElementOrder = MatrixElementOrder.ColumnMajor,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As SymmetricMatrix(Of T)

C++/CLI

public:
generic<typename T>
static SymmetricMatrix<T>^ WrapSymmetric(
	Memory2D<T> source, 
	int dimension, 
	MatrixTriangle storedTriangle = MatrixTriangle::Upper, 
	MatrixElementOrder elementOrder = MatrixElementOrder::ColumnMajor, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member WrapSymmetric : 
        source : Memory2D<'T> * 
        dimension : int * 
        ?storedTriangle : MatrixTriangle * 
        ?elementOrder : MatrixElementOrder * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _storedTriangle = defaultArg storedTriangle MatrixTriangle.Upper
        let _elementOrder = defaultArg elementOrder MatrixElementOrder.ColumnMajor
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> SymmetricMatrix<'T>

Parameters

source Memory2D<T>: A Memory2D<T> to wrap.
dimension Int32: The number of rows and columns in the symmetric matrix.
storedTriangle MatrixTriangle (Optional): Specifies whether the upper or lower triangle is stored.
elementOrder MatrixElementOrder (Optional): 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: The element type of the matrix.

Return Value

SymmetricMatrix<T>
A new SymmetricMatrix<T> that wraps the source storage.

Remarks

Changes to the matrix will affect the original storage, and vice versa.

Matrix.WrapSymmetric Method

Definition

Overload List

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

Parameters

Type Parameters

Return Value

Remarks

Exceptions

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

Parameters

Type Parameters

Return Value

Remarks

Exceptions

WrapSymmetric<T>(Memory2D<T>, Int32, MatrixTriangle, MatrixElementOrder, ArrayMutability)

Parameters

Type Parameters

Return Value

Remarks

See Also

Reference