public Class MaxIter

Class Inheritance

extends Object
implements OptimizationData

All Implemented Interfaces

org.apache.commons.math3.optim.OptimizationData

Imports

Maximum number of iterations performed by an (iterative) algorithm.

Field Summary

Modifier and Type	Field and Description
private final int	maxIter Allowed number of evalutations.

Access	Constructor and Description
public	MaxIter(int Allowed number of iterations. max)

Modifier and Type	Method and Description
public int	Returns: the allowed number of evaluations. getMaxIter() Gets the maximum number of evaluations.
public static MaxIter	Returns: a new instance suitable for allowing `Integer#MAX_VALUE` evaluations. unlimited() Factory method that creates instance of this class that represents a virtually unlimited number of iterations.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

maxIter	back to summary
private final int maxIter Allowed number of evalutations.

MaxIter	back to summary
public MaxIter(int max) Parameters max:int Allowed number of iterations. Exceptions NotStrictlyPositiveException: if `max <= 0`.

getMaxIter	back to summary
public int getMaxIter() Gets the maximum number of evaluations. Returns:int the allowed number of evaluations.

getMaxIter

public int getMaxIter()

Gets the maximum number of evaluations.

unlimited back to summary

unlimited	back to summary
public static MaxIter unlimited() Factory method that creates instance of this class that represents a virtually unlimited number of iterations. Returns:MaxIter a new instance suitable for allowing `Integer#MAX_VALUE` evaluations.

public static MaxIter unlimited()

Factory method that creates instance of this class that represents a virtually unlimited number of iterations.

Returns:MaxIter: a new instance suitable for allowing Integer#MAX_VALUE evaluations.