FreeHEP API
Version current

hep.aida.ext
Interface IOptimizerConfiguration

All Known Implementing Classes:
AbstractOptimizerConfiguration

public interface IOptimizerConfiguration

Source Code:
IOptimizerConfiguration.java

Field Summary
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
 int errorDefinition()
          Get the optimizer's error definition.
 int maxIterations()
          Get the maximum number of iterations allowed before exiting the optimization procedure.
 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(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(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.
 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

public static final int DEFAULT_ERROR
The error definition for the optimizers.

See Also:
Constant Field Values

CHI2_FIT_ERROR

public static final int CHI2_FIT_ERROR
See Also:
Constant Field Values

LOGL_FIT_ERROR

public static final int LOGL_FIT_ERROR
See Also:
Constant Field Values

NO_OUTPUT

public static final int NO_OUTPUT
The printout levels for the optimizer.

See Also:
Constant Field Values

NORMAL_OUTPUT

public static final int NORMAL_OUTPUT
See Also:
Constant Field Values

DETAILED_OUTPUT

public static final int DETAILED_OUTPUT
See Also:
Constant Field Values
Method Detail

setTolerance

public void setTolerance(double tolerance)
                  throws IllegalArgumentException
Set the optimizer's tolerance. The tolerance is used to determine if the optimizer converged to an optimal solution.

Parameters:
tolerance - The tolerance.
Returns:
true if the tolerance was set succesfully, false otherwise.
Throws:
IllegalArgumentException

tolerance

public double tolerance()
Get the optimizer's tolerance.

Returns:
The tolerance.

setPrecision

public void setPrecision(double precision)
                  throws IllegalArgumentException
Set the precision required in the optimizer's calculations. The highest possible is the machine's precision.

Parameters:
precision - The precision.
Returns:
true if the precision was set succesfully, false otherwise.
Throws:
IllegalArgumentException

precision

public double precision()
Get the internal precision of the Optimizer.

Returns:
The precision.

setErrorDefinition

public void setErrorDefinition(int errDef)
                        throws IllegalArgumentException
Tell the optmizer what kind of errors to calculate.

Parameters:
errDef - The type of error to be calculated.
Throws:
IllegalArgumentException

errorDefinition

public int errorDefinition()
Get the optimizer's error definition.

Returns:
The error definition.

setMaxIterations

public void setMaxIterations(int maxIter)
                      throws 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:
IllegalArgumentException

maxIterations

public int maxIterations()
Get the maximum number of iterations allowed before exiting the optimization procedure.

Returns:
The maximum number of iterations.

setPrintLevel

public void setPrintLevel(int printLevel)
                   throws IllegalArgumentException
Set the printout level.

Parameters:
printLevel - The printout level.
Returns:
true if the level was set succesfully, false otherwise.
Throws:
IllegalArgumentException

printLevel

public int printLevel()
Get the printout level.

Returns:
the printout level.

setTitle

public void setTitle(String title)
Set the title for the current optimization problem.

Parameters:
title - The title.

title

public String title()
Get the title.

Returns:
The title.

setUseFunctionGradient

public 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

public 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

public 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

public 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

public void setStrategy(int strategy)
                 throws IllegalArgumentException
Set the strategy to be used by the optimizer in the optimization procedure.

Parameters:
strategy - The strategy.
Throws:
IllegalArgumentException

strategy

public int strategy()
Get the strategy used by the optimizer in the optimization procedure.

Returns:
The strategy.

setMethod

public void setMethod(String method)
               throws IllegalArgumentException
Set the method to be used by the optimizer in the optimization procedure.

Parameters:
method - The method to be adapted.
Throws:
IllegalArgumentException

method

public String method()
Get the method used by the optimizer in the optimization procedure.

Returns:
The method used.

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.