.NET Matrix Library
CEigen Constructor(CMatrix,Boolean,Boolean,BalanceType)
See Also  Send Feedback



matrix
A CMatrix object representing the complex square matrix whose eigenvalues and optionally its right and/or left eigenvectors are to be computed.
rightEigenvectors
boolean value specifying whether the right eigenvectors will be computed.
leftEigenvectors
A boolean value specifying whether the left eigenvectors will be computed.
balance
A BalanceType enumeration specifying whether preliminary balancing will be used and the type of balancing.
Creates a new instance of the CEigen class computing the eigenvalues and optionally the right and/or the left eigenvectors of a general square complex matrix, using the specified type of preliminary matrix balancing.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal matrix As CMatrix, _
   ByVal rightEigenvectors As Boolean, _
   ByVal leftEigenvectors As Boolean, _
   ByVal balance As BalanceType _
)
Visual Basic (Usage)Copy Code
Dim matrix As CMatrix
Dim rightEigenvectors As Boolean
Dim leftEigenvectors As Boolean
Dim balance As BalanceType
 
Dim instance As New CEigen(matrix, rightEigenvectors, leftEigenvectors, balance)
C# 
public CEigen( 
   CMatrix matrix,
   bool rightEigenvectors,
   bool leftEigenvectors,
   BalanceType balance
)
C++/CLI 
public:
CEigen( 
   CMatrix^ matrix,
   bool rightEigenvectors,
   bool leftEigenvectors,
   BalanceType balance
)

Parameters

matrix
A CMatrix object representing the complex square matrix whose eigenvalues and optionally its right and/or left eigenvectors are to be computed.
rightEigenvectors
boolean value specifying whether the right eigenvectors will be computed.
leftEigenvectors
A boolean value specifying whether the left eigenvectors will be computed.
balance
A BalanceType enumeration specifying whether preliminary balancing will be used and the type of balancing.

Exceptions

ExceptionDescription
NotSquareMatrixExceptionmatrix parameter does not represent a square matrix.

Remarks

Balancing a matrix means permuting its rows and columns to make it more nearly upper triangular, and applying similarity transformations to make its rows and columns closer in norm.

Generally balancing improves the accuracy of the computations. However, there are cases that a matrix contains near to zero elements that are due to round-off errors. If balancing is used, those elements may become the same significant as others leading to incorrect eigenvectors. To avoid such a situation set the balance parameter to false.

Requirements

Target Platforms: Windows 2000, Windows XP, Windows Server 2003 family, Windows Vista, Windows Server 2008 family, Windows 7

See Also

.NET Matrix Library