Constructs a FloatHermitianBandMatrix instance by extracting the Hermitian part of
a band of entries from a square matrix.
Namespace:
CenterSpace.NMath.MatrixAssembly: NMath (in NMath.dll) Version: 5.1.0.0
Syntax
| C# |
|---|
public FloatHermitianBandMatrix( FloatComplexMatrix A, int halfBandwidth ) |
| Visual Basic (Declaration) |
|---|
Public Sub New ( _ A As FloatComplexMatrix, _ halfBandwidth As Integer _ ) |
| Visual C++ |
|---|
public: FloatHermitianBandMatrix( FloatComplexMatrix^ A, int halfBandwidth ) |
Parameters
- A
- Type: CenterSpace.NMath.Core..::.FloatComplexMatrix
A square matrix.
- halfBandwidth
- Type: System..::.Int32
The number of superdiagonals to extract. This is also the half bandwidth of the resulting Hermitian banded matrix.
Remarks
The main diagonal is extracted along
with halfBandwidth superdiagonals from the upper triangular part of A.
Exceptions
| Exception | Condition |
|---|---|
| CenterSpace.NMath.Core..::.InvalidArgumentException | Thrown if the number of rows of A is less than the bandwidth of resulting banded matrix. |
| CenterSpace.NMath.Core..::.MatrixNotSquareException | Thrown if the input matrix, A, is not square. |