Click or drag to resize

NewtonFindRoot Class

Locates the root of a function using the Newton-Raphson method.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.NumericalMethods.AdvancedNewtonFindRoot

Namespace:  AGI.Foundation.NumericalMethods.Advanced
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public class NewtonFindRoot

The NewtonFindRoot type exposes the following members.

Constructors
  NameDescription
Public methodNewtonFindRoot
Initializes a new instance that can be used to find roots of a specified function. SetInitialGuessOfRootLocation(Double) must be called before FindRoot(Int32). MaximumStepsize is set to an initial value of MaxValue, VariableTolerance is set to an initial value of zero.
Top
Properties
  NameDescription
Public propertyDerivativeFunction
Gets the derivative of Function.
Public propertyDerivativeTolerance
Gets or sets the tolerance used to determine whether the derivative is zero for the purposes of aborting the calculation and setting the ResultType to SolverFailedDueToHorizontalSlope.
Public propertyDerivativeValue
Gets the value of the DerivativeFunction at the Root.
Public propertyFunction
Gets the evaluation function.
Public propertyFunctionTolerance
Gets or sets the tolerance used to determine whether the function is zero and a root has been found.
Public propertyFunctionValue
Gets the value of the Function at the Root.
Public propertyIterations
Gets the number of iterations taken.
Public propertyLowerBound
Gets or sets the lower bound of the range of independent variables to search for the root within.
Public propertyMaximumStepsize
Gets or sets the maximum size of the step to take during a single iteration.
Public propertyResultType
Gets the type of result the Root represents.
Public propertyRoot
Gets the value of the root. Consult the ResultType property for whether the calculated root is the result of a finished calculation, or some other failure condition such as the failure to converge in the allotted number of maximum iterations.
Public propertyUpperBound
Gets or sets the upper bound of the range of independent variables to search for the root within.
Public propertyVariableTolerance
Gets or sets the tolerance used to determine whether a root guess is the same as another root guess, used in early detection of non-convergence.
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 methodFindRoot
Attempts the indicated number of iterations to locate the root of the function to within the required convergence criteria.
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 methodSetInitialGuessOfRootLocation
Sets the initial guess of the root's location. This sets Root to the provided guess, ResultType to InitialGuess and Iterations is set to 0. If Function and/or DerivativeFunction are non-null the method also assigns assigns FunctionValue and DerivativeValue respectively.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also