Click or drag to resize

PowerMethod Class

Class for computing the dominant eigenvalue and eigenvector of a square matrix using the iterative power method.
Inheritance Hierarchy
SystemObject
  CenterSpace.NMath.CorePowerMethod

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.3
Syntax
public class PowerMethod

The PowerMethod type exposes the following members.

Constructors
  NameDescription
Public methodPowerMethod
Constructs a PowerMethod instance with the default tolerance and maximum number of iterations.
Public methodPowerMethod(Double)
Constructs a PowerMethod instance with the specified tolerance and default maximum number of iterations.
Public methodPowerMethod(Int32)
Constructs a PowerMethod instance withe the specified maximum number of iterations and the default tolerance.
Public methodPowerMethod(Double, Int32)
Constructs a PowerMethod instance with the specified tolerance and maximum number of iterations.
Top
Properties
  NameDescription
Public propertyDominantEigenvalue
Gets the dominant eigenvalue.
Public propertyDominantEigenvector
Gets the dominant eigenvector.
Public propertyIsGood
Returns true if the most recent calculation converged with respect to the tolerance in less than the maximum number of iterations.
Public propertyMaxIterations
Gets and sets the maximum number of iterations to perform.
Public propertyMessage
Returns a message in the case of a failure.
Public propertyNumIterations
Gets the number of iterations performed in the most recent calculation.
Public propertyTolerance
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.
Top
Methods
  NameDescription
Public methodCalculateDominantEigenvector
Calculates the dominant eigenvalue and eigenvector of the given square matrix.
Top
Fields
  NameDescription
Public fieldStatic memberDEFAULT_MAX_ITERATIONS
The default maximum number of iterations that will be assigned to all PowerMethod instances when one is not specified.
Public fieldStatic memberDEFAULT_TOLERANCE
The default tolerance that will be assigned to all PowerMethod instances when one is not specified.
Top
See Also