EquationSystemSolver Class

Serves as an abstract base class for classes that solve systems of non-linear equations.

Definition

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

public abstract class EquationSystemSolver : ManagedIterativeAlgorithm

Visual Basic

Public MustInherit Class EquationSystemSolver
	Inherits ManagedIterativeAlgorithm

C++/CLI

public ref class EquationSystemSolver abstract : public ManagedIterativeAlgorithm

[<AbstractClassAttribute>]
type EquationSystemSolver = 
    class
        inherit ManagedIterativeAlgorithm
    end

Inheritance: Object → ManagedIterativeAlgorithm<Object, Double, SolutionReport<Object, Double>> → ManagedIterativeAlgorithm<Object> → ManagedIterativeAlgorithm → EquationSystemSolver

Derived: Numerics.NET.EquationSolvers.DoglegSystemSolver
Numerics.NET.EquationSolvers.NewtonRaphsonSystemSolver

Remarks

The EquationSystemSolver class is the abstract base class of all classes that implement algorithms that solve systems of non-linear equations. The class inherits from ManagedIterativeAlgorithm. All the properties and methods exposed by this interface are available to all derived classes.

This class cannot be instantiated directly. Instead, use one of the following derived classes:

NewtonRaphsonSystemSolver – Represents a EquationSystemSolver that uses the Newton-Raphson algorithm in multiple dimensions.
DoglegSystemSolver – Represents a EquationSystemSolver that uses Powell's dogleg algorithm.

Constructors

EquationSystemSolver

Constructs a new EquationSystemSolver object.

Properties

ConvergenceTests	Gets the collection of convergence tests for the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
CurrentPoint	Gets or sets the current best approximation to the solution.
CurrentValue	Gets or sets the value of the target functions at the current point.
Dimensions	Gets or sets the number of dimensions of the optimization problem.
EstimatedError	Gets a value indicating the size of the absolute error of the result. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
EvaluationsNeeded	Gets the number of evaluations needed to execute the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
EvaluationsRemaining	Gets the number of evaluations still available. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
HasSharedDegreeOfParallelism	Indicates whether the degree of parallelism is a property that is shared across instances. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
InitialGuess	Gets or sets the initial value for the Newton-Raphson iteration.
InitializeJacobian	Gets or sets whether the Jacobian should be initialized to an all zero matrix.
IterationsNeeded	Gets the number of iterations needed by the algorithm to reach the desired accuracy. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
IterationsRemaining	Gets the number of iterations remaining. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
JacobianFunction	Gets or sets the Jacobian for the EquationSystemSolver.
JacobianMatrix	Gets the Jacobian matrix of the system of equations for the current point.
LastCorrection	Gets the last correction to the solution of the system of equations.
MaxDegreeOfParallelism	Gets or sets the maximum degree of parallelism enabled by this instance. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
MaxEvaluations	Gets or sets the maximum number of evaluations during the calculation. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
MaxIterations	Gets or sets the maximum number of iterations to use when approximating the roots of the target function. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
MinIterations	Gets or sets the minimum iterations that have to be performed. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ParallelOptions	Gets or sets the configuration for the parallel behavior of the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Result	Gets the result of an algorithm after it has executed. (Overrides ManagedIterativeAlgorithm<T, TError, TReport>.Result)
RightHandSide	Gets or sets the right-hand side of the system of equations.
SolutionReport	Gets the result of an algorithm after it has executed. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
SolutionTest	Gets the VectorConvergenceTest<T> that uses the approximate solution.
Status	Gets the AlgorithmStatus following an execution of the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
TargetFunction	Gets or sets the target function for the EquationSystemSolver.
ThrowExceptionOnFailure	Gets or sets whether to throw an exception when the algorithm fails to converge. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ValueTest	Gets the VectorConvergenceTest<T> that uses the value of the target functions.

Methods

Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Evaluate	Evaluates the target functions of the system of equations.
EvaluateJacobian	Evaluates the Jacobian of the system of equations for the current point.
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
IncrementEvaluations()	Increments the number of evaluations by one. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
IncrementEvaluations(Int32)	Increments the number of evaluations by the specified amount. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Iterate	Performs one iteration of the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Iterated	Performs tasks after the iteration is completed, but before the status of the algorithm is finalized. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
OnConvergence	Performs any tasks after the main algorithm has converged. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
OnFailure	Performs any tasks after the main algorithm has failed to converge. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
OnInit	Performs initialization before the first iteration. (Overrides ManagedIterativeAlgorithm<T, TError, TReport>.OnInit())
ReportFailure	Records the results of an algorithm in case it fails. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ReportResult	Records the results of an algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ReportSuccess	Records the results of a algorithm that converged successfully. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ResetEvaluations	Resets the number of evaluations to zero. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Restart	Prepares the algorithm to be run again with possibly different inputs. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Run()	Runs the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Run(ParallelOptions)	Runs the algorithm using the specified parallelization options. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
SetGradientFunctions(Func<Vector<Double>, Vector<Double>>[])	Sets the target functions.
SetGradientFunctions(Func<Vector<Double>, Vector<Double>, Vector<Double>>[])	Sets the target functions.
SetResult	Sets the results of an algorithm's execution. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
SetSymbolicTargetFunctions	Defines the left hand sides of the equations to solve as a set of lambda expressions.
SetTargetFunctions	Sets the target functions.
Solve()	Attempts to find a root or zero of the target function.
Solve(Vector<Double>)	Attempts to find the point where the target function equals the specified value.
TestConvergence	Checks whether the algorithm has converged. (Overrides ManagedIterativeAlgorithm<T, TError, TReport>.TestConvergence())
ThreadSafeIncrementEvaluations()	Increments the number of evaluations by one. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ThreadSafeIncrementEvaluations(Int32)	Increments the number of evaluations by the specified amount. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ThrowConvergenceException	Interprets the AlgorithmStatus and throws the appropriate exception. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ToString	Returns a string that represents the current object. (Inherited from Object)

Fields

DefaultMaxIterations

Specifies the default maximum number of iterations to use when approximating the roots of the target function.