Matrix.ExtractUpperTriangle Method

Definition

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

Overload List

ExtractUpperTriangle<T>(DenseMatrix<T>)	Constructs a TriangularMatrix<T> whose elements are contained in the storedTriangle triangular portion of a DenseMatrix<T>.
ExtractUpperTriangle<T>(HermitianMatrix<T>)	Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a HermitianMatrix<T>.
ExtractUpperTriangle<T>(DenseMatrix<T>, MatrixDiagonal)	Constructs a TriangularMatrix<T> whose elements are contained in the upper triangular portion of a DenseMatrix<T>.
ExtractUpperTriangle<T>(HermitianMatrix<T>, MatrixDiagonal)	Constructs an upper TriangularMatrix<T> whose elements are contained in the upper triangular portion of a HermitianMatrix<T>.
ExtractUpperTriangle<T>(SymmetricMatrix<T>, MatrixDiagonal)	Constructs an upper TriangularMatrix<T> whose elements are contained in the upper triangular portion of a SymmetricMatrix<T>.
ExtractUpperTriangle<T>(DenseMatrix<T>, Int32, Int32, MatrixDiagonal)	Constructs a TriangularMatrix<T> whose elements are contained in the upper triangular portion of a DenseMatrix<T>.

ExtractUpperTriangle<T>(DenseMatrix<T>)

Constructs a TriangularMatrix<T> whose elements are contained in the storedTriangle triangular portion of a DenseMatrix<T>.

public static TriangularMatrix<T> ExtractUpperTriangle<T>(
	DenseMatrix<T> matrix
)

Visual Basic

Public Shared Function ExtractUpperTriangle(Of T) ( 
	matrix As DenseMatrix(Of T)
) As TriangularMatrix(Of T)

C++/CLI

public:
generic<typename T>
static TriangularMatrix<T>^ ExtractUpperTriangle(
	DenseMatrix<T>^ matrix
)

static member ExtractUpperTriangle : 
        matrix : DenseMatrix<'T> -> TriangularMatrix<'T>

Parameters

matrix DenseMatrix<T>: A DenseMatrix<T>.

Type Parameters

T

Return Value

TriangularMatrix<T>
A TriangularMatrix<T> whose elements are contained in the storedTriangle triangular portion of matrix.

Exceptions

ArgumentNullException

matrix is null.

ExtractUpperTriangle<T>(HermitianMatrix<T>)

Constructs a TriangularMatrix<T> whose elements are contained in the lower triangular portion of a HermitianMatrix<T>.

public static TriangularMatrix<T> ExtractUpperTriangle<T>(
	HermitianMatrix<T> matrix
)

Visual Basic

Public Shared Function ExtractUpperTriangle(Of T) ( 
	matrix As HermitianMatrix(Of T)
) As TriangularMatrix(Of T)

C++/CLI

public:
generic<typename T>
static TriangularMatrix<T>^ ExtractUpperTriangle(
	HermitianMatrix<T>^ matrix
)

static member ExtractUpperTriangle : 
        matrix : HermitianMatrix<'T> -> TriangularMatrix<'T>

Parameters

matrix HermitianMatrix<T>: A HermitianMatrix<T>.

Type Parameters

T

Return Value

TriangularMatrix<T>
A TriangularMatrix<T> whose elements are contained in the lower triangular portion of matrix.

Exceptions

ArgumentNullException

matrix is null.

ExtractUpperTriangle<T>(DenseMatrix<T>, MatrixDiagonal)

Constructs a TriangularMatrix<T> whose elements are contained in the upper triangular portion of a DenseMatrix<T>.

public static TriangularMatrix<T> ExtractUpperTriangle<T>(
	DenseMatrix<T> matrix,
	MatrixDiagonal unitDiagonal
)

Visual Basic

Public Shared Function ExtractUpperTriangle(Of T) ( 
	matrix As DenseMatrix(Of T),
	unitDiagonal As MatrixDiagonal
) As TriangularMatrix(Of T)

C++/CLI

public:
generic<typename T>
static TriangularMatrix<T>^ ExtractUpperTriangle(
	DenseMatrix<T>^ matrix, 
	MatrixDiagonal unitDiagonal
)

static member ExtractUpperTriangle : 
        matrix : DenseMatrix<'T> * 
        unitDiagonal : MatrixDiagonal -> TriangularMatrix<'T>

Parameters

matrix DenseMatrix<T>: A DenseMatrix<T>.
unitDiagonal MatrixDiagonal: If true, the matrix is unit triangular. Only the elements below the diagonal in matrix are considered. If false, the diagonal elements of matrix are taken as the diagonal elements of the triangular matrix.

Type Parameters

T

Return Value

TriangularMatrix<T>
A TriangularMatrix<T> whose elements are contained in the upper triangular portion of matrix.

Exceptions

ArgumentNullException

matrix is null.

ExtractUpperTriangle<T>(HermitianMatrix<T>, MatrixDiagonal)

Constructs an upper TriangularMatrix<T> whose elements are contained in the upper triangular portion of a HermitianMatrix<T>.

public static TriangularMatrix<T> ExtractUpperTriangle<T>(
	HermitianMatrix<T> matrix,
	MatrixDiagonal unitDiagonal
)

Visual Basic

Public Shared Function ExtractUpperTriangle(Of T) ( 
	matrix As HermitianMatrix(Of T),
	unitDiagonal As MatrixDiagonal
) As TriangularMatrix(Of T)

C++/CLI

public:
generic<typename T>
static TriangularMatrix<T>^ ExtractUpperTriangle(
	HermitianMatrix<T>^ matrix, 
	MatrixDiagonal unitDiagonal
)

static member ExtractUpperTriangle : 
        matrix : HermitianMatrix<'T> * 
        unitDiagonal : MatrixDiagonal -> TriangularMatrix<'T>

Parameters

matrix HermitianMatrix<T>: A HermitianMatrix<T>.
unitDiagonal MatrixDiagonal: If true, the matrix is unit triangular. Only the elements below the diagonal in matrix are considered. If false, the diagonal elements of matrix are taken as the diagonal elements of the triangular matrix.

Type Parameters

T

Return Value

TriangularMatrix<T>
A TriangularMatrix<T> whose elements are contained in the lower triangular portion of matrix.

Exceptions

ArgumentNullException

matrix is null.

ExtractUpperTriangle<T>(SymmetricMatrix<T>, MatrixDiagonal)

Constructs an upper TriangularMatrix<T> whose elements are contained in the upper triangular portion of a SymmetricMatrix<T>.

public static TriangularMatrix<T> ExtractUpperTriangle<T>(
	SymmetricMatrix<T> matrix,
	MatrixDiagonal unitDiagonal = MatrixDiagonal.NonUnitDiagonal
)

Visual Basic

Public Shared Function ExtractUpperTriangle(Of T) ( 
	matrix As SymmetricMatrix(Of T),
	Optional unitDiagonal As MatrixDiagonal = MatrixDiagonal.NonUnitDiagonal
) As TriangularMatrix(Of T)

C++/CLI

public:
generic<typename T>
static TriangularMatrix<T>^ ExtractUpperTriangle(
	SymmetricMatrix<T>^ matrix, 
	MatrixDiagonal unitDiagonal = MatrixDiagonal::NonUnitDiagonal
)

static member ExtractUpperTriangle : 
        matrix : SymmetricMatrix<'T> * 
        ?unitDiagonal : MatrixDiagonal 
(* Defaults:
        let _unitDiagonal = defaultArg unitDiagonal MatrixDiagonal.NonUnitDiagonal
*)
-> TriangularMatrix<'T>

Parameters

matrix SymmetricMatrix<T>: A SymmetricMatrix<T>.
unitDiagonal MatrixDiagonal (Optional): If true, the matrix is unit triangular. Only the elements below the diagonal in matrix are considered. If false, the diagonal elements of matrix are taken as the diagonal elements of the triangular matrix.

Type Parameters

T

Return Value

TriangularMatrix<T>
A TriangularMatrix<T> whose elements are contained in the lower triangular portion of matrix.

Exceptions

ArgumentNullException

matrix is null.

ExtractUpperTriangle<T>(DenseMatrix<T>, Int32, Int32, MatrixDiagonal)

Constructs a TriangularMatrix<T> whose elements are contained in the upper triangular portion of a DenseMatrix<T>.

public static TriangularMatrix<T> ExtractUpperTriangle<T>(
	DenseMatrix<T> matrix,
	int rowCount,
	int columnCount,
	MatrixDiagonal unitDiagonal = MatrixDiagonal.NonUnitDiagonal
)

Visual Basic

Public Shared Function ExtractUpperTriangle(Of T) ( 
	matrix As DenseMatrix(Of T),
	rowCount As Integer,
	columnCount As Integer,
	Optional unitDiagonal As MatrixDiagonal = MatrixDiagonal.NonUnitDiagonal
) As TriangularMatrix(Of T)

C++/CLI

public:
generic<typename T>
static TriangularMatrix<T>^ ExtractUpperTriangle(
	DenseMatrix<T>^ matrix, 
	int rowCount, 
	int columnCount, 
	MatrixDiagonal unitDiagonal = MatrixDiagonal::NonUnitDiagonal
)

static member ExtractUpperTriangle : 
        matrix : DenseMatrix<'T> * 
        rowCount : int * 
        columnCount : int * 
        ?unitDiagonal : MatrixDiagonal 
(* Defaults:
        let _unitDiagonal = defaultArg unitDiagonal MatrixDiagonal.NonUnitDiagonal
*)
-> TriangularMatrix<'T>

Parameters

matrix DenseMatrix<T>: A DenseMatrix<T>.
rowCount Int32: The number of rows in the TriangularMatrix<T>.
columnCount Int32: The number of columns in the TriangularMatrix<T>.
unitDiagonal MatrixDiagonal (Optional): If true, the matrix is unit triangular. Only the elements below the diagonal in matrix are considered. If false, the diagonal elements of matrix are taken as the diagonal elements of the triangular matrix.

Type Parameters

T

Return Value

TriangularMatrix<T>
A TriangularMatrix<T> whose elements are contained in the lower triangular portion of matrix.

Exceptions

ArgumentNullException

matrix is null.

ArgumentOutOfRangeException

rowCount is less than zero or greater than or equal to the number of rows in matrix.

-or-

columnCount is less than zero or greater than or equal to the number of columns in matrix.

Matrix.ExtractUpperTriangle Method

Definition

Overload List

ExtractUpperTriangle<T>(DenseMatrix<T>)

Parameters

Type Parameters

Return Value

Exceptions

ExtractUpperTriangle<T>(HermitianMatrix<T>)

Parameters

Type Parameters

Return Value

Exceptions

ExtractUpperTriangle<T>(DenseMatrix<T>, MatrixDiagonal)

Parameters

Type Parameters

Return Value

Exceptions

ExtractUpperTriangle<T>(HermitianMatrix<T>, MatrixDiagonal)

Parameters

Type Parameters

Return Value

Exceptions

ExtractUpperTriangle<T>(SymmetricMatrix<T>, MatrixDiagonal)

Parameters

Type Parameters

Return Value

Exceptions

ExtractUpperTriangle<T>(DenseMatrix<T>, Int32, Int32, MatrixDiagonal)

Parameters

Type Parameters

Return Value

Exceptions

See Also

Reference