C# Class Accord.Math.RelativeConvergence

Relative convergence criteria.

This class can be used to track progress and convergence of methods which rely on the relative change of a value.

Inheritance: ISingleValueConvergence

Public Methods

Method	Description
Clear ( ) : void	Resets this instance, reverting all iteration statistics statistics (number of iterations, last error) back to zero.
RelativeConvergence ( ) : System	Initializes a new instance of the RelativeConvergence class.
RelativeConvergence ( int iterations, double tolerance ) : System	Initializes a new instance of the RelativeConvergence class.
RelativeConvergence ( int iterations, double tolerance, int checks ) : System	Initializes a new instance of the RelativeConvergence class.

Method	Description
checkConvergence ( ) : bool

Resets this instance, reverting all iteration statistics statistics (number of iterations, last error) back to zero.

public Clear ( ) : void
return	void

Initializes a new instance of the RelativeConvergence class.

public RelativeConvergence ( ) : System
return	System

Initializes a new instance of the RelativeConvergence class.

public RelativeConvergence ( int iterations, double tolerance ) : System
iterations	int	The maximum number of iterations which should be /// performed by the iterative algorithm. Setting to zero indicates there /// is no maximum number of iterations. Default is 100.
tolerance	double	The maximum relative change in the watched value /// after an iteration of the algorithm used to detect convergence. /// Default is 0.
return	System

Initializes a new instance of the RelativeConvergence class.

public RelativeConvergence ( int iterations, double tolerance, int checks ) : System
iterations	int	The maximum number of iterations which should be /// performed by the iterative algorithm. Setting to zero indicates there /// is no maximum number of iterations. Default is 0.
tolerance	double	The maximum relative change in the watched value /// after an iteration of the algorithm used to detect convergence. /// Default is 0.
checks	int	The minimum number of convergence checks that the /// iterative algorithm should pass before convergence can be declared /// reached.
return	System