Matrix.CopyFromUpperTriangular Method

Definition

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

Overload List

CopyFromUpperTriangular<T>(Matrix<T>, MatrixDiagonal, ArrayMutability)	Returns an independent copy of the upper triangular part of a matrix.
CopyFromUpperTriangular<T>(Matrix<T>, Int32, Int32, MatrixDiagonal, ArrayMutability)	Returns an independent copy of the upper triangular part of a matrix with explicit dimensions.
CopyFromUpperTriangular<T>(T[], Int32, Int32, MatrixDiagonal, MatrixElementOrder, ArrayMutability)	Creates a new upper TriangularMatrix<T> by copying data from a one-dimensional array.

CopyFromUpperTriangular<T>(Matrix<T>, MatrixDiagonal, ArrayMutability)

Returns an independent copy of the upper triangular part of a matrix.

public static Matrix<T> CopyFromUpperTriangular<T>(
	Matrix<T> source,
	MatrixDiagonal diagonal = MatrixDiagonal.NonUnitDiagonal,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function CopyFromUpperTriangular(Of T) ( 
	source As Matrix(Of T),
	Optional diagonal As MatrixDiagonal = MatrixDiagonal.NonUnitDiagonal,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As Matrix(Of T)

C++/CLI

public:
generic<typename T>
static Matrix<T>^ CopyFromUpperTriangular(
	Matrix<T>^ source, 
	MatrixDiagonal diagonal = MatrixDiagonal::NonUnitDiagonal, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member CopyFromUpperTriangular : 
        source : Matrix<'T> * 
        ?diagonal : MatrixDiagonal * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _diagonal = defaultArg diagonal MatrixDiagonal.NonUnitDiagonal
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> Matrix<'T>

Parameters

source Matrix<T>: The source matrix.
diagonal MatrixDiagonal (Optional): A MatrixDiagonal value that specifies whether the diagonal elements are copied from the source or set to one. The default is NonUnitDiagonal.
mutability ArrayMutability (Optional): The desired mutability of the copy. The default is MutableValues.

Type Parameters

T: The element type of the matrix.

Return Value

Matrix<T>
A new matrix containing the upper triangular part of source; all elements below the diagonal are zero. In Professional edition this may be a TriangularMatrix<T>.

Exceptions

ArgumentNullException

source is null.

CopyFromUpperTriangular<T>(Matrix<T>, Int32, Int32, MatrixDiagonal, ArrayMutability)

Returns an independent copy of the upper triangular part of a matrix with explicit dimensions.

public static Matrix<T> CopyFromUpperTriangular<T>(
	Matrix<T> source,
	int rowCount,
	int columnCount,
	MatrixDiagonal diagonal = MatrixDiagonal.NonUnitDiagonal,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function CopyFromUpperTriangular(Of T) ( 
	source As Matrix(Of T),
	rowCount As Integer,
	columnCount As Integer,
	Optional diagonal As MatrixDiagonal = MatrixDiagonal.NonUnitDiagonal,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As Matrix(Of T)

C++/CLI

public:
generic<typename T>
static Matrix<T>^ CopyFromUpperTriangular(
	Matrix<T>^ source, 
	int rowCount, 
	int columnCount, 
	MatrixDiagonal diagonal = MatrixDiagonal::NonUnitDiagonal, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member CopyFromUpperTriangular : 
        source : Matrix<'T> * 
        rowCount : int * 
        columnCount : int * 
        ?diagonal : MatrixDiagonal * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _diagonal = defaultArg diagonal MatrixDiagonal.NonUnitDiagonal
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> Matrix<'T>

Parameters

source Matrix<T>: The source matrix.
rowCount Int32: The number of rows of the copy. Must be between 0 and the row count of source (inclusive).
columnCount Int32: The number of columns of the copy. Must be between 0 and the column count of source (inclusive).
diagonal MatrixDiagonal (Optional): A MatrixDiagonal value that specifies whether the diagonal elements are copied from the source or set to one. The default is NonUnitDiagonal.
mutability ArrayMutability (Optional): The desired mutability of the copy. The default is MutableValues.

Type Parameters

T: The element type of the matrix.

Return Value

Matrix<T>
A new rowCount×columnCount matrix containing the upper triangular part of the leading submatrix of source; all elements below the diagonal are zero.

Exceptions

ArgumentNullException

source is null.

ArgumentOutOfRangeException

rowCount is less than 0 or greater than the row count of source.

-or-

columnCount is less than 0 or greater than the column count of source.

CopyFromUpperTriangular<T>(T[], Int32, Int32, MatrixDiagonal, MatrixElementOrder, ArrayMutability)

Creates a new upper TriangularMatrix<T> by copying data from a one-dimensional array.

public static TriangularMatrix<T> CopyFromUpperTriangular<T>(
	T[] source,
	int rowCount,
	int columnCount,
	MatrixDiagonal diagonal = MatrixDiagonal.NonUnitDiagonal,
	MatrixElementOrder elementOrder = MatrixElementOrder.ColumnMajor,
	ArrayMutability mutability = ArrayMutability.MutableValues
)

Visual Basic

Public Shared Function CopyFromUpperTriangular(Of T) ( 
	source As T(),
	rowCount As Integer,
	columnCount As Integer,
	Optional diagonal As MatrixDiagonal = MatrixDiagonal.NonUnitDiagonal,
	Optional elementOrder As MatrixElementOrder = MatrixElementOrder.ColumnMajor,
	Optional mutability As ArrayMutability = ArrayMutability.MutableValues
) As TriangularMatrix(Of T)

C++/CLI

public:
generic<typename T>
static TriangularMatrix<T>^ CopyFromUpperTriangular(
	array<T>^ source, 
	int rowCount, 
	int columnCount, 
	MatrixDiagonal diagonal = MatrixDiagonal::NonUnitDiagonal, 
	MatrixElementOrder elementOrder = MatrixElementOrder::ColumnMajor, 
	ArrayMutability mutability = ArrayMutability::MutableValues
)

static member CopyFromUpperTriangular : 
        source : 'T[] * 
        rowCount : int * 
        columnCount : int * 
        ?diagonal : MatrixDiagonal * 
        ?elementOrder : MatrixElementOrder * 
        ?mutability : ArrayMutability 
(* Defaults:
        let _diagonal = defaultArg diagonal MatrixDiagonal.NonUnitDiagonal
        let _elementOrder = defaultArg elementOrder MatrixElementOrder.ColumnMajor
        let _mutability = defaultArg mutability ArrayMutability.MutableValues
*)
-> TriangularMatrix<'T>

Parameters

source T[]: A one-dimensional array containing the triangular matrix values.
rowCount Int32: The number of rows in the matrix.
columnCount Int32: The number of columns in the matrix.
diagonal MatrixDiagonal (Optional): Specifies whether the matrix has a unit diagonal.
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

TriangularMatrix<T>
A new upper TriangularMatrix<T> with copied data.

Exceptions

ArgumentNullException

source is null.

Matrix.CopyFromUpperTriangular Method

Definition

Overload List

CopyFromUpperTriangular<T>(Matrix<T>, MatrixDiagonal, ArrayMutability)

Parameters

Type Parameters

Return Value

Exceptions

CopyFromUpperTriangular<T>(Matrix<T>, Int32, Int32, MatrixDiagonal, ArrayMutability)

Parameters

Type Parameters

Return Value

Exceptions

CopyFromUpperTriangular<T>(T[], Int32, Int32, MatrixDiagonal, MatrixElementOrder, ArrayMutability)

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference