IterativeAlgorithm<T> Class

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

Definition

Namespace: Numerics.NET.Algorithms
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4

public abstract class IterativeAlgorithm<T> : ManagedIterativeAlgorithm<T, T, SolutionReport<T, T>>

Visual Basic

Public MustInherit Class IterativeAlgorithm(Of T)
	Inherits ManagedIterativeAlgorithm(Of T, T, SolutionReport(Of T, T))

C++/CLI

generic<typename T>
public ref class IterativeAlgorithm abstract : public ManagedIterativeAlgorithm<T, T, SolutionReport<T, T>^>

[<AbstractClassAttribute>]
type IterativeAlgorithm<'T> = 
    class
        inherit ManagedIterativeAlgorithm<'T, 'T, SolutionReport<'T, 'T>>
    end

Inheritance: Object → ManagedIterativeAlgorithm<T, T, SolutionReport<T, T>> → IterativeAlgorithm<T>

Derived: Numerics.NET.Calculus.Generic.NumericalIntegrator<T>
Numerics.NET.Calculus.NumericalIntegrator
Numerics.NET.Calculus.NumericalIntegrator2D
Numerics.NET.Calculus.NumericalIntegratorND
Numerics.NET.EquationSolvers.EquationSolver
Numerics.NET.EquationSolvers.Generic.EquationSolver<T>
More Less

Type Parameters

T

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

IterativeAlgorithm<T>

Constructs a new IterativeAlgorithm<T> object.

Properties

AbsoluteTolerance	Gets or sets the absolute tolerance used in the convergence test.
ConvergenceCriterion	Gets or sets a value specifying the criterion that is to be used in the convergence test for the algorithm.
ConvergenceTest	Gets the convergence test for the algorithm.
ConvergenceTests	Gets the collection of convergence tests for the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
CurrentError	Gets the estimated error of the approximation of the result at the current iteration.
CurrentResult	Gets the approximation of the result at the current iteration.
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>)
EvaluationsRemaining	Gets the number of evaluations still available. (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>)
IterationsNeeded	Gets the number of iterations needed by the algorithm to reach the desired accuracy. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
IterationsRemaining	Gets the number of iterations remaining. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
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>)
MaxIterations	Gets 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.
Result	Gets the result of an algorithm after it has executed. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
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>)
ThrowExceptionOnFailure	Gets or sets 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)
ErrorEvaluator	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)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
IncrementEvaluations()	Increments the number of evaluations by one. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
IncrementEvaluations(Int32)	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())
MemberwiseClone	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())
ReportFailure(AlgorithmStatus)	Reports that the algoritm has failed. No further iterations will be performed.
ReportFailure(T, TError, AlgorithmStatus)	Records the results of an algorithm in case it fails. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ReportResult	Records the results of an algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ReportSuccess()	Reports that the algoritm has succeeded. No further iterations will be performed.
ReportSuccess(T, TError)	Records the results of a algorithm that converged successfully. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ResetEvaluations	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(ParallelOptions)	Runs the algorithm using the specified parallelization options. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
SetResult	Sets the results of an algorithm's execution. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
TestConvergence	Checks whether the algorithm has converged. (Overrides ManagedIterativeAlgorithm<T, TError, TReport>.TestConvergence())
ThreadSafeIncrementEvaluations()	Increments the number of evaluations by one. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ThreadSafeIncrementEvaluations(Int32)	Increments the number of evaluations by the specified amount. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ThrowConvergenceException	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)
UpdateCurrentResult	Updates the current approximation in a point-wise convergence.
ValueEvaluator	Returns the value to compare the estimated error to when testing whether the algorithm has converged.