NewtonFindRoot Class |
Namespace: AGI.Foundation.NumericalMethods.Advanced
The NewtonFindRoot type exposes the following members.
Name | Description | |
---|---|---|
NewtonFindRoot |
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.
|
Name | Description | |
---|---|---|
DerivativeFunction |
Gets the derivative of Function.
| |
DerivativeTolerance |
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.
| |
DerivativeValue |
Gets the value of the DerivativeFunction at the Root.
| |
Function |
Gets the evaluation function.
| |
FunctionTolerance |
Gets or sets the tolerance used to determine whether the function is zero and a root has been found.
| |
FunctionValue | ||
Iterations |
Gets the number of iterations taken.
| |
LowerBound |
Gets or sets the lower bound of the range of independent variables to search for the root within.
| |
MaximumStepsize |
Gets or sets the maximum size of the step to take during a single iteration.
| |
ResultType |
Gets the type of result the Root represents.
| |
Root |
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.
| |
UpperBound |
Gets or sets the upper bound of the range of independent variables to search for the root within.
| |
VariableTolerance |
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.
|
Name | Description | |
---|---|---|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
FindRoot |
Attempts the indicated number of iterations to locate the root of the function
to within the required convergence criteria.
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
SetInitialGuessOfRootLocation |
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.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) |