hep.aida.ext

Interface IOptimizerConfiguration

All Known Implementing Classes:

AbstractOptimizerConfiguration, FminOptimizerConfiguration, MinpackOptimizerConfiguration, UncminOptimizerConfiguration

public interface IOptimizerConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHI2_FIT_ERROR
static int	DEFAULT_ERROR The error definition for the optimizers.
static int	DETAILED_OUTPUT
static int	LOGL_FIT_ERROR
static int	NO_OUTPUT The printout levels for the optimizer.
static int	NORMAL_OUTPUT

Method Summary

Modifier and Type	Method and Description
int	errorDefinition() Get the optimizer's error definition.
int	maxIterations() Get the maximum number of iterations allowed before exiting the optimization procedure.
java.lang.String	method() Get the method used by the optimizer in the optimization procedure.
double	precision() Get the internal precision of the Optimizer.
int	printLevel() Get the printout level.
void	setErrorDefinition(int errDef) Tell the optmizer what kind of errors to calculate.
void	setMaxIterations(int maxIter) Set the maximum number of iterations to be performed in the optimization procedure.
void	setMethod(java.lang.String method) Set the method to be used by the optimizer in the optimization procedure.
void	setPrecision(double precision) Set the precision required in the optimizer's calculations.
void	setPrintLevel(int printLevel) Set the printout level.
void	setStrategy(int strategy) Set the strategy to be used by the optimizer in the optimization procedure.
void	setTitle(java.lang.String title) Set the title for the current optimization problem.
void	setTolerance(double tolerance) Set the optimizer's tolerance.
void	setUseFunctionGradient(boolean useGradient) Specify if the optimizer has to use the gradient as provided by the IFunction.
void	setUseFunctionHessian(boolean useHessian) Specify if the optimizer has to use the Hessian as provided by the IFunction.
int	strategy() Get the strategy used by the optimizer in the optimization procedure.
java.lang.String	title() Get the title.
double	tolerance() Get the optimizer's tolerance.
boolean	useFunctionGradient() See if the optimizer uses the IFunction's evaluation of the gradient.
boolean	useFunctionHessian() See if the optimizer uses the IFunction's evaluation of the Hessian.

Field Detail

DEFAULT_ERROR

static final int DEFAULT_ERROR

The error definition for the optimizers.

See Also:

Constant Field Values

CHI2_FIT_ERROR

static final int CHI2_FIT_ERROR

See Also:

Constant Field Values

LOGL_FIT_ERROR

static final int LOGL_FIT_ERROR

See Also:

Constant Field Values

NO_OUTPUT

static final int NO_OUTPUT

The printout levels for the optimizer.

See Also:

Constant Field Values

NORMAL_OUTPUT

static final int NORMAL_OUTPUT

See Also:

Constant Field Values

DETAILED_OUTPUT

static final int DETAILED_OUTPUT

See Also:

Constant Field Values

Method Detail

setTolerance

void setTolerance(double tolerance)
           throws java.lang.IllegalArgumentException

Set the optimizer's tolerance. The tolerance is used to determine if the optimizer converged to an optimal solution.

Parameters:

tolerance - The tolerance.

Throws:

java.lang.IllegalArgumentException

tolerance

double tolerance()

Get the optimizer's tolerance.

Returns:

The tolerance.

setPrecision

void setPrecision(double precision)
           throws java.lang.IllegalArgumentException

Set the precision required in the optimizer's calculations. The highest possible is the machine's precision.

Parameters:

precision - The precision.

Throws:

java.lang.IllegalArgumentException

precision

double precision()

Get the internal precision of the Optimizer.

Returns:

The precision.

setErrorDefinition

void setErrorDefinition(int errDef)
                 throws java.lang.IllegalArgumentException

Tell the optmizer what kind of errors to calculate.

Parameters:

errDef - The type of error to be calculated.

Throws:

java.lang.IllegalArgumentException

errorDefinition

int errorDefinition()

Get the optimizer's error definition.

Returns:

The error definition.

setMaxIterations

void setMaxIterations(int maxIter)
               throws java.lang.IllegalArgumentException

Set the maximum number of iterations to be performed in the optimization procedure. If the optimizer did not converge before maxIter iterations the optimization will stop.

Parameters:

maxIter - The maximum number of iterations.

Throws:

java.lang.IllegalArgumentException

maxIterations

int maxIterations()

Get the maximum number of iterations allowed before exiting the optimization procedure.

Returns:

The maximum number of iterations.

setPrintLevel

void setPrintLevel(int printLevel)
            throws java.lang.IllegalArgumentException

Set the printout level.

Parameters:

printLevel - The printout level.

Throws:

java.lang.IllegalArgumentException

printLevel

int printLevel()

Get the printout level.

Returns:

the printout level.

setTitle

void setTitle(java.lang.String title)

Set the title for the current optimization problem.

Parameters:

title - The title.

title

java.lang.String title()

Get the title.

Returns:

The title.

setUseFunctionGradient

void setUseFunctionGradient(boolean useGradient)

Specify if the optimizer has to use the gradient as provided by the IFunction.

Parameters:

useGradient - true if the Optimizer has to use the IFunction's calculation of the gradient, false otherwise.

useFunctionGradient

boolean useFunctionGradient()

See if the optimizer uses the IFunction's evaluation of the gradient.

Returns:

true if the optimizer uses the IFunction's evaluation of the gradient.

setUseFunctionHessian

void setUseFunctionHessian(boolean useHessian)

Specify if the optimizer has to use the Hessian as provided by the IFunction.

Parameters:

useHessian - true if the Optimizer has to use the IFunction's calculation of the Hessian, false otherwise.

useFunctionHessian

boolean useFunctionHessian()

See if the optimizer uses the IFunction's evaluation of the Hessian.

Returns:

true if the optimizer uses the IFunction's evaluation of the Hessian.

setStrategy

void setStrategy(int strategy)
          throws java.lang.IllegalArgumentException

Set the strategy to be used by the optimizer in the optimization procedure.

Parameters:

strategy - The strategy.

Throws:

java.lang.IllegalArgumentException

strategy

int strategy()

Get the strategy used by the optimizer in the optimization procedure.

Returns:

The strategy.

setMethod

void setMethod(java.lang.String method)
        throws java.lang.IllegalArgumentException

Set the method to be used by the optimizer in the optimization procedure.

Parameters:

method - The method to be adapted.

Throws:

java.lang.IllegalArgumentException

method

java.lang.String method()

Get the method used by the optimizer in the optimization procedure.

Returns:

The method used.