Click or drag to resize

NewtonRaphson Class

A class for finding zeros of a method, using the Newton-Raphson method

If the derivative is available, it can be provided, otherwise it works by numerically calculating the derivative.

Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Generic.MathAlgorithmsNewtonRaphson

Namespace:  DHI.Mike1D.Generic.MathAlgorithms
Assembly:  DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class NewtonRaphson

The NewtonRaphson type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyDerivative
Derivative of function to solve, if available, otherwise null.
Public propertyEpsilon
Epsilon, used in stopping criteria in the Newton-Raphson method.

Default value is 1e-6

Both the Epsilon and the FEpsilon criteria must be met before the method is stopped

Public propertyFEpsilon
F-Epsilon, used in stopping criteria in the Newton-Raphson method.

Default value is 1 (in most cases that is the same as disabling the criteria)

Both the Epsilon and the FEpsilon criteria must be met before the method is stopped

Public propertyFunc
Function to solve
Public propertyMaxIter
Maximum number of iterations. Default 100
Public propertyNewValueAction
Action to perform when a new value is calculated.
Public propertyNumIter
Hold the actual number of iterations for the last solve.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSolve
Solves for zeros, using x as starting point and updating the value of x as a result.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also