# IterativeAlgorithm Class

Acts as an abstract base class for classes that implement
an iterative algorithm.

## Definition

**Namespace:**Extreme.Mathematics.Algorithms

**Assembly:**Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

`public abstract class IterativeAlgorithm : ManagedIterativeAlgorithm<double>`

- Inheritance
- Object → ManagedIterativeAlgorithm<Double, Double, SolutionReport<Double, Double>> → ManagedIterativeAlgorithm<Double> → IterativeAlgorithm

- Derived

## Remarks

This class is primarily used to support iterative algorithms within the library. It defines properties and methods that are shared by all iterative algorithm implementations.

It is likely that the implementation details of iterative algorithms will change in the future. Some interface changes may also be required.

## Constructors

Iterative | Constructs a new IterativeAlgorithm object. |

## Properties

Absolute | Gets or sets the absolute tolerance used in the convergence test. |

Convergence | Gets or sets a value specifying the criterion that is to be used in the convergence test for the algorithm. |

Convergence | Gets the convergence test for the algorithm. |

Convergence |
Gets the collection of convergence tests for the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Current | Gets the estimated error of the approximation of the result at the current iteration. |

Current | Gets the approximation of the result at the current iteration. |

Estimated |
Gets a value indicating the size of the absolute
error of the result.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Evaluations |
Gets the number of evaluations needed to execute the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Evaluations |
Gets the number of evaluations still available.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Has |
Indicates whether the degree of parallelism is a property that is shared
across instances.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Iterations |
Gets the number of iterations needed by the
algorithm to reach the desired accuracy.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Iterations |
Gets the number of iterations remaining.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Max |
Gets or sets the maximum degree of parallelism enabled by this instance.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Max |
Gets or sets the maximum number of evaluations during the calculation.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Max | Gets or sets the maximum number of iterations
to use when approximating the roots of the target
function.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Min |
Gets or sets the minimum iterations that have to be performed.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Parallel |
Gets or sets the configuration for the parallel behavior of the algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Relative | Gets or sets the relative tolerance used in the convergence test. |

Result |
Gets the result of an algorithm after it has executed.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Solution |
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>) |

Throw |
Gets or sets a value indicating whether to throw an
exception when the algorithm fails to converge.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

## Methods

Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |

Error | Returns the estimated error for testing whether the algorithm has converged. |

Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |

Get | Serves as the default hash function. (Inherited from Object) |

Get | Gets the Type of the current instance. (Inherited from Object) |

Increment |
Increments the number of evaluations by one.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Increment |
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.
(Overrides ManagedIterativeAlgorithm<T, TError, TReport>.Iterated()) |

Memberwise | 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 tasks when the algorithm is first run.
(Overrides ManagedIterativeAlgorithm<T, TError, TReport>.OnInit()) |

Report | Reports that the algoritm has failed. No further iterations will be performed. |

Report |
Records the results of an algorithm in case it fails.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Report |
Records the results of an algorithm.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Report | Reports that the algoritm has succeeded. No further iterations will be performed. |

Report |
Records the results of a algorithm that converged successfully.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Reset |
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( |
Runs the algorithm using the specified parallelization options.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Set |
Sets the results of an algorithm's execution.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Test |
Checks whether the algorithm has converged.
(Overrides ManagedIterativeAlgorithm<T, TError, TReport>.TestConvergence()) |

Thread |
Increments the number of evaluations by one.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Thread |
Increments the number of evaluations by the specified amount.
(Inherited from ManagedIterativeAlgorithm<T, TError, TReport>) |

Throw |
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) |

Update | Updates the current approximation in a point-wise convergence. |

Value | Returns the value to compare the estimated error to when testing whether the algorithm has converged. |