DenseMatrix<T, TSlice, TStorage2D>.GetLowerTriangularView Method

Definition

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

Overload List

GetLowerTriangularView(MatrixDiagonal)	Returns a TriangularMatrix<T> view over the lower triangular portion of this matrix.
GetLowerTriangularView(Int32, Int32, MatrixDiagonal)	Returns a TriangularMatrix<T> view over the lower triangular portion of this matrix.
GetLowerTriangularView(Int32, Int32, MatrixDiagonal, Int32, Int32)	Returns a TriangularMatrix<T> view over the lower triangular portion of this matrix.

GetLowerTriangularView(Int32, Int32, MatrixDiagonal, Int32, Int32)

Returns a TriangularMatrix<T> view over the lower triangular portion of this matrix.

public override TriangularMatrix<T> GetLowerTriangularView(
	int rowCount,
	int columnCount,
	MatrixDiagonal unitDiagonal = MatrixDiagonal.NonUnitDiagonal,
	int startRow = 0,
	int startColumn = 0
)

Visual Basic

Public Overrides Function GetLowerTriangularView ( 
	rowCount As Integer,
	columnCount As Integer,
	Optional unitDiagonal As MatrixDiagonal = MatrixDiagonal.NonUnitDiagonal,
	Optional startRow As Integer = 0,
	Optional startColumn As Integer = 0
) As TriangularMatrix(Of T)

C++/CLI

public:
virtual TriangularMatrix<T>^ GetLowerTriangularView(
	int rowCount, 
	int columnCount, 
	MatrixDiagonal unitDiagonal = MatrixDiagonal::NonUnitDiagonal, 
	int startRow = 0, 
	int startColumn = 0
) override

abstract GetLowerTriangularView : 
        rowCount : int * 
        columnCount : int * 
        ?unitDiagonal : MatrixDiagonal * 
        ?startRow : int * 
        ?startColumn : int 
(* Defaults:
        let _unitDiagonal = defaultArg unitDiagonal MatrixDiagonal.NonUnitDiagonal
        let _startRow = defaultArg startRow 0
        let _startColumn = defaultArg startColumn 0
*)
-> TriangularMatrix<'T> 
override GetLowerTriangularView : 
        rowCount : int * 
        columnCount : int * 
        ?unitDiagonal : MatrixDiagonal * 
        ?startRow : int * 
        ?startColumn : int 
(* Defaults:
        let _unitDiagonal = defaultArg unitDiagonal MatrixDiagonal.NonUnitDiagonal
        let _startRow = defaultArg startRow 0
        let _startColumn = defaultArg startColumn 0
*)
-> TriangularMatrix<'T>

Parameters

rowCount Int32: The number of rows in the TriangularMatrix<T>.
columnCount Int32: The number of columns in the TriangularMatrix<T>.
unitDiagonal MatrixDiagonal (Optional): A MatrixDiagonal value that specifies whether the diagonal elements are read from this matrix or treated as implied ones.
startRow Int32 (Optional): The row in the matrix of the first element of the new matrix.
startColumn Int32 (Optional): The column in the matrix of the first element of the new matrix.

Return Value

TriangularMatrix<T>
A TriangularMatrix<T> view whose stored elements are backed by the lower triangular portion of this matrix.

Remarks

The returned matrix shares storage with this matrix. Changes made through either matrix are visible through the other for elements that are part of the triangular view.

Exceptions

ArgumentOutOfRangeException

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

-or-

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