Click or drag to resize
Accord.NET (logo)

ISingleValueConvergence Interface

Common interface for convergence detection algorithms that depend solely on a single value (such as the iteration error).

Namespace:  Accord.Math
Assembly:  Accord.Math (in Accord.Math.dll) Version: 3.8.0
Syntax
public interface ISingleValueConvergence : IConvergence<double>, 
	IConvergence
Request Example View Source

The ISingleValueConvergence type exposes the following members.

Properties
  NameDescription
Public propertyCurrentIteration
Gets the current iteration number.
(Inherited from IConvergence.)
Public propertyHasConverged
Gets or sets whether the algorithm has converged.
(Inherited from IConvergence.)
Public propertyIterations Obsolete.
Please use MaxIterations instead.
(Inherited from IConvergenceT.)
Public propertyMaxIterations
Gets or sets the maximum number of iterations performed by the iterative algorithm.
(Inherited from IConvergence.)
Public propertyNewValue
Gets or sets the watched value after the iteration.
(Inherited from IConvergenceT.)
Public propertyTolerance
Gets or sets the maximum relative change in the watched value after an iteration of the algorithm used to detect convergence.
(Inherited from IConvergence.)
Top
Methods
  NameDescription
Public methodClear
Resets this instance, reverting all iteration statistics statistics (number of iterations, last error) back to zero.
(Inherited from IConvergence.)
Top
See Also