BandMatrix<T>.ToGeneralBandMatrix Method

Definition

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

Overload List

ToGeneralBandMatrix() Makes a copy of this instance and returns it as a general band matrix.
ToGeneralBandMatrix(Boolean) Makes a copy of this instance and returns it as a general band matrix.

ToGeneralBandMatrix

Makes a copy of this instance and returns it as a general band matrix.
C# 
public BandMatrix<T> ToGeneralBandMatrix()

Return Value

BandMatrix<T>
A DenseMatrix<T> that is a copy of this instance.

Remarks

The method converts a symmetric band matrix into a general band matrix. Only the components on and above the main diagonal of a symmetric band matrix are stored. This method constructs a band matrix that also stores the components below the main diagonal.

ToGeneralBandMatrix(Boolean)

Makes a copy of this instance and returns it as a general band matrix.
C# 
public abstract BandMatrix<T> ToGeneralBandMatrix(
	bool allocateForLUDecomposition
)

Parameters

allocateForLUDecomposition  Boolean
A Boolean that indicates whether to allocate extra storage for a subsequent LU decomposition.

Return Value

BandMatrix<T>
A DenseMatrix<T> that is a copy of this instance.

Remarks

This method has two primary uses. The first is to convert a symmetric band matrix into a general band matrix. Only the components on and above the main diagonal of a symmetric band matrix are stored. This method constructs a band matrix that also stores the components below the main diagonal.

The second use is to create a matrix suitable for computing an LU decomposition. The upper triangular part of an LU decomposition has a larger bandwidth than the original matrix. In order to calculate the LU decomposition, sufficient space must be allocated for these extra nonzero components.

See Also