FreeHEP API
Version current

hep.aida.ref.optimizer.minuit
Class MinuitOptimizerConfiguration

java.lang.Object
  extended byhep.aida.ref.optimizer.AbstractOptimizerConfiguration
      extended byhep.aida.ref.optimizer.minuit.MinuitOptimizerConfiguration
All Implemented Interfaces:
IOptimizerConfiguration

public class MinuitOptimizerConfiguration
extends AbstractOptimizerConfiguration

Implementation of IOptimizerConfiguration

Author:
Tony Johnson, Victor Serbo, Max Turri
Source Code:
MinuitOptimizerConfiguration.java

Field Summary
static int HIGH_CALL_STRATEGY
           
static String IMPROVE
          The methods available in Minuit.
static int LOW_CALL_STRATEGY
          The kind of strategies available in Minuit.
static int MEDIUM_CALL_STRATEGY
           
static String MIGRAD
           
static String MINIMIZE
           
static String SEEK
           
static String SIMPLEX
           
 
Fields inherited from interface hep.aida.ext.IOptimizerConfiguration
CHI2_FIT_ERROR, DEFAULT_ERROR, DETAILED_OUTPUT, LOGL_FIT_ERROR, NO_OUTPUT, NORMAL_OUTPUT
 
Constructor Summary
MinuitOptimizerConfiguration(MinuitOptimizer optimizer)
          Creates a new instance of MinuitOptimizerConfiguration
 
Method Summary
 int errorDefinition()
          Get the optimizer's error definition.
protected  void setDefaults()
           
 void setErrorDefinition(int errorDefinition)
          Tell the optmizer what kind of errors to calculate.
 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 setUseFunctionGradient(boolean useFunctionGradient)
          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.
 
Methods inherited from class hep.aida.ref.optimizer.AbstractOptimizerConfiguration
maxIterations, method, precision, printLevel, setMaxIterations, setTitle, setTolerance, strategy, title, tolerance, useFunctionGradient, useFunctionHessian
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOW_CALL_STRATEGY

public static final int LOW_CALL_STRATEGY
The kind of strategies available in Minuit.

See Also:
Constant Field Values

MEDIUM_CALL_STRATEGY

public static final int MEDIUM_CALL_STRATEGY
See Also:
Constant Field Values

HIGH_CALL_STRATEGY

public static final int HIGH_CALL_STRATEGY
See Also:
Constant Field Values

IMPROVE

public static final String IMPROVE
The methods available in Minuit.

See Also:
Constant Field Values

MIGRAD

public static final String MIGRAD
See Also:
Constant Field Values

MINIMIZE

public static final String MINIMIZE
See Also:
Constant Field Values

SIMPLEX

public static final String SIMPLEX
See Also:
Constant Field Values

SEEK

public static final String SEEK
See Also:
Constant Field Values
Constructor Detail

MinuitOptimizerConfiguration

public MinuitOptimizerConfiguration(MinuitOptimizer optimizer)
Creates a new instance of MinuitOptimizerConfiguration

Method Detail

setDefaults

protected void setDefaults()

setErrorDefinition

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

Specified by:
setErrorDefinition in interface IOptimizerConfiguration
Overrides:
setErrorDefinition in class AbstractOptimizerConfiguration
Parameters:
errorDefinition - The type of error to be calculated.

errorDefinition

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

Specified by:
errorDefinition in interface IOptimizerConfiguration
Overrides:
errorDefinition in class AbstractOptimizerConfiguration
Returns:
The error definition.

setMethod

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

Specified by:
setMethod in interface IOptimizerConfiguration
Overrides:
setMethod in class AbstractOptimizerConfiguration
Parameters:
method - The method to be adapted.

setPrecision

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

Specified by:
setPrecision in interface IOptimizerConfiguration
Overrides:
setPrecision in class AbstractOptimizerConfiguration
Parameters:
precision - The precision.
Returns:
true if the precision was set succesfully, false otherwise.

setStrategy

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

Specified by:
setStrategy in interface IOptimizerConfiguration
Overrides:
setStrategy in class AbstractOptimizerConfiguration
Parameters:
strategy - The strategy.

setUseFunctionGradient

public void setUseFunctionGradient(boolean useFunctionGradient)
Specify if the optimizer has to use the gradient as provided by the IFunction.

Specified by:
setUseFunctionGradient in interface IOptimizerConfiguration
Overrides:
setUseFunctionGradient in class AbstractOptimizerConfiguration
Parameters:
useFunctionGradient - true if the Optimizer has to use the IFunction's calculation of the gradient, false otherwise.

setPrintLevel

public void setPrintLevel(int printLevel)
Description copied from class: AbstractOptimizerConfiguration
Set the printout level.

Specified by:
setPrintLevel in interface IOptimizerConfiguration
Overrides:
setPrintLevel in class AbstractOptimizerConfiguration
Parameters:
printLevel - The printout level.
Returns:
true if the level was set succesfully, false otherwise.

setUseFunctionHessian

public void setUseFunctionHessian(boolean useHessian)
Description copied from class: AbstractOptimizerConfiguration
Specify if the optimizer has to use the Hessian as provided by the IFunction.

Specified by:
setUseFunctionHessian in interface IOptimizerConfiguration
Overrides:
setUseFunctionHessian in class AbstractOptimizerConfiguration
Parameters:
useHessian - true if the Optimizer has to use the IFunction's calculation of the Hessian, false otherwise.

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.