 | Power |
Class for computing the dominant eigenvalue and eigenvector of a square
matrix using the iterative power method.
Inheritance HierarchyNamespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4
SyntaxThe PowerMethod type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PowerMethod | Constructs a PowerMethod instance with the default tolerance and maximum number of iterations. |
| PowerMethod(Double) | Constructs a PowerMethod instance with the specified tolerance and default maximum number of iterations. |
| PowerMethod(Int32) | Constructs a PowerMethod instance withe the specified maximum number of iterations and the default tolerance. |
| PowerMethod(Double, Int32) | Constructs a PowerMethod instance with the specified tolerance and maximum number of iterations. |
Properties| Name | Description | |
|---|---|---|
 | DominantEigenvalue | Gets the dominant eigenvalue. |
| DominantEigenvector | Gets the dominant eigenvector. |
| IsGood | Returns true if the most recent calculation converged with respect to the tolerance in less than the maximum number of iterations. |
| MaxIterations | Gets and sets the maximum number of iterations to perform. |
| Message | Returns a message in the case of a failure. |
| NumIterations | Gets the number of iterations performed in the most recent calculation. |
| Tolerance | Gets and sets the tolerance. The power method converges if changes in the normalized eigenvector, with respect to the infinity norm, is less than this specified tolerance. |
Methods| Name | Description | |
|---|---|---|
| CalculateDominantEigenvector | Calculates the dominant eigenvalue and eigenvector of the given square matrix. |
Fields| Name | Description | |
|---|---|---|
  | DEFAULT_MAX_ITERATIONS | The default maximum number of iterations that will be assigned to all PowerMethod instances when one is not specified. |
| DEFAULT_TOLERANCE | The default tolerance that will be assigned to all PowerMethod instances when one is not specified. |
See Also