Package boofcv.misc

Class ConfigConverge

java.lang.Object

boofcv.misc.ConfigConverge

All Implemented Interfaces:

Configuration, Serializable

public class ConfigConverge
extends Object
implements Configuration

Generic configuration for optimization routines

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
double	ftol	Relative threshold for change in function value between iterations.
double	gtol	Absolute threshold for convergence based on the gradient's norm.
int	maxIterations	Maximum number of iterations.

Constructor Summary

Constructors

Constructor	Description
ConfigConverge()
ConfigConverge(double ftol, double gtol, int maxIterations)
ConfigConverge(ConfigConverge src)

Method Summary

Modifier and Type	Method	Description
void	checkValidity()	Checks to see if the configuration is valid.
ConfigConverge	setTo(double ftol, double gtol, int maxIterations)
ConfigConverge	setTo(ConfigConverge src)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface boofcv.struct.Configuration

serializeActiveFields, serializeInitialize

Field Details

ftol

public double ftol

Relative threshold for change in function value between iterations. 0 ≤ ftol ≤ 1.

gtol

public double gtol

Absolute threshold for convergence based on the gradient's norm. 0 disables test. gtol ≥ 0.

maxIterations

public int maxIterations

Maximum number of iterations. What is defined as an iteration is implementation specific.

Constructor Details

ConfigConverge

public ConfigConverge(double ftol,
 double gtol,
 int maxIterations)

ConfigConverge

public ConfigConverge(ConfigConverge src)

ConfigConverge

public ConfigConverge()

Method Details

setTo

public ConfigConverge setTo(double ftol,
 double gtol,
 int maxIterations)

setTo

public ConfigConverge setTo(ConfigConverge src)

checkValidity

public void checkValidity()

Description copied from interface: Configuration

Checks to see if the configuration is valid. If it is invalid, throw an exception explaining what is incorrect.

Specified by:

checkValidity in interface Configuration