Top Description Fields Constructors Methods
org.apache.commons.math3.optim

public Class MaxEval

extends Object
implements OptimizationData
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.optim.OptimizationData
Imports
org.apache.commons.math3.exception.NotStrictlyPositiveException

Maximum number of evaluations of the function to be optimized.
Since
3.1

Field Summary

Modifier and TypeField and Description
private final int
maxEval

Allowed number of evalutations.

Constructor Summary

AccessConstructor and Description
public
MaxEval(int
Allowed number of evalutations.
max
)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the allowed number of evaluations.
getMaxEval
()

Gets the maximum number of evaluations.

public static MaxEval

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 evaluations.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

maxEvalback to summary
private final int maxEval

Allowed number of evalutations.

Constructor Detail

MaxEvalback to summary
public MaxEval(int max)
Parameters
max:int

Allowed number of evalutations.

Exceptions
NotStrictlyPositiveException:
if max <= 0.

Method Detail

getMaxEvalback to summary
public int getMaxEval()

Gets the maximum number of evaluations.

Returns:int

the allowed number of evaluations.

unlimitedback to summary
public static MaxEval unlimited()

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

Returns:MaxEval

a new instance suitable for allowing Integer#MAX_VALUE evaluations.