Package org.hipparchus.optim
Class MaxIter
- java.lang.Object
-
- org.hipparchus.optim.MaxIter
-
- All Implemented Interfaces:
OptimizationData
public class MaxIter extends Object implements OptimizationData
Maximum number of iterations performed by an (iterative) algorithm.
-
-
Constructor Summary
Constructors Constructor Description MaxIter(int max)
Simple constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getMaxIter()
Gets the maximum number of evaluations.static MaxIter
unlimited()
Factory method that creates instance of this class that represents a virtually unlimited number of iterations.
-
-
-
Constructor Detail
-
MaxIter
public MaxIter(int max)
Simple constructor.- Parameters:
max
- Allowed number of iterations.- Throws:
MathIllegalArgumentException
- ifmax <= 0
.
-
-
Method Detail
-
getMaxIter
public int getMaxIter()
Gets the maximum number of evaluations.- Returns:
- the allowed number of evaluations.
-
unlimited
public static MaxIter unlimited()
Factory method that creates instance of this class that represents a virtually unlimited number of iterations.- Returns:
- a new instance suitable for allowing
Integer.MAX_VALUE
evaluations.
-
-