NewtonRaphsonSolver Class

Represents a root finder based on the Newton-Raphson algorithm.

Definition

Namespace: Extreme.Mathematics.EquationSolvers
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23
C#
public sealed class NewtonRaphsonSolver : EquationSolver
Inheritance
Object  →  ManagedIterativeAlgorithm<Double, Double, SolutionReport<Double, Double>>  →  ManagedIterativeAlgorithm<Double>  →  IterativeAlgorithm  →  EquationSolver  →  NewtonRaphsonSolver

Remarks

The Newton-Raphson algorithm starts from a single starting value. It then uses the derivative of the target function to find successive approximations of the root.

NewtonRaphsonSolver inherits from EquationSolver, which in turn inherits from IterativeAlgorithm. All properties of IterativeAlgorithm are available. The AbsoluteTolerance and RelativeTolerance properties set the desired precision as specified by the ConvergenceCriterion property. The default value for both tolerances is SqrtEpsilon (roughly 10-8). MaxIterations sets the maximum number of iterations.

The TargetFunction property is a function of one variable that specifies the function we want to find a root for. The LowerBound and UpperBound properties specify the bounds of the bracketing interval. The target function must have a different sign at each end of this interval.

The Solve() method performs the actual approximation of the root. This method returns the best approximation that was found. The Status property indicates whether the algorithm was successful. The EstimatedError property gives an upper bound for the difference between the approximated and the actual root.

Constructors

NewtonRaphsonSolver() Constructs a new NewtonRaphsonSolver object.
NewtonRaphsonSolver(Func<Double, Double>, Func<Double, Double>, Double) Constructs a new NewtonRaphsonSolver object.
NewtonRaphsonSolver(Func<Double, Double>, Func<Double, Double>, Double, ConvergenceCriterion, Double) Constructs a new NewtonRaphsonSolver object.

Properties

AbsoluteTolerance Gets or sets the absolute tolerance used in the convergence test.
(Inherited from IterativeAlgorithm)
ConvergenceCriterion Gets or sets a value specifying the criterion that is to be used in the convergence test for the algorithm.
(Inherited from IterativeAlgorithm)
ConvergenceTest Gets the convergence test for the algorithm.
(Inherited from IterativeAlgorithm)
ConvergenceTests Gets the collection of convergence tests for the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
DerivativeOfTargetFunction Gets or sets the derivative of the target function.
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>)
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.
IterationsNeeded Gets the number of iterations needed by the algorithm to reach the desired accuracy.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
LowerBound Gets or sets the lower bound for the solution.
(Inherited from EquationSolver)
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>)
MaxIterationsGets 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>)
RelativeTolerance Gets or sets the relative tolerance used in the convergence test.
(Inherited from IterativeAlgorithm)
Result Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
RightHandSide Gets or sets the value of the target function to solve for.
(Inherited from EquationSolver)
SolutionReport Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
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 EquationSolver.
(Inherited from EquationSolver)
ThrowExceptionOnFailure Gets or sets a value indicating whether to throw an exception when the algorithm fails to converge.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
UpperBound Gets or sets the upper bound for the solution.
(Inherited from EquationSolver)

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Solve() Attempts to find a root or zero of the target function.
(Inherited from EquationSolver)
Solve(Double) Attempts to find the point where the target function equals the specified value.
(Inherited from EquationSolver)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also