FreeHEP API
Version current

hep.aida.ref.optimizer.fmin
Class FminOptimizerConfiguration

java.lang.Object
  extended byhep.aida.ref.optimizer.AbstractOptimizerConfiguration
      extended byhep.aida.ref.optimizer.fmin.FminOptimizerConfiguration
All Implemented Interfaces:
IOptimizerConfiguration

public class FminOptimizerConfiguration
extends AbstractOptimizerConfiguration

Implementation of IOptimizerConfiguration for the Fmin optimizer

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

Field Summary
static String FMIN
          The methods available in Fmin.
 
Fields inherited from interface hep.aida.ext.IOptimizerConfiguration
CHI2_FIT_ERROR, DEFAULT_ERROR, DETAILED_OUTPUT, LOGL_FIT_ERROR, NO_OUTPUT, NORMAL_OUTPUT
 
Constructor Summary
FminOptimizerConfiguration()
          Creates a new instance of FminOptimizerConfiguration
 
Method Summary
 int maxIterations()
          Get the maximum number of iterations allowed before exiting the optimization procedure.
 void setMaxIterations(int iterations)
          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 setStrategy(int strategy)
          Set the strategy to be used by the optimizer in the optimization procedure.
 void setUseFunctionGradient(boolean useFG)
          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.
 
Methods inherited from class hep.aida.ref.optimizer.AbstractOptimizerConfiguration
errorDefinition, method, precision, printLevel, setErrorDefinition, setPrintLevel, setTitle, setTolerance, title, tolerance, useFunctionGradient, useFunctionHessian
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FMIN

public static final String FMIN
The methods available in Fmin.

See Also:
Constant Field Values
Constructor Detail

FminOptimizerConfiguration

public FminOptimizerConfiguration()
Creates a new instance of FminOptimizerConfiguration

Method Detail

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.

setMaxIterations

public void setMaxIterations(int iterations)
Description copied from class: AbstractOptimizerConfiguration
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.

Specified by:
setMaxIterations in interface IOptimizerConfiguration
Overrides:
setMaxIterations in class AbstractOptimizerConfiguration
Parameters:
iterations - The maximum number of iterations.

maxIterations

public int maxIterations()
Description copied from class: AbstractOptimizerConfiguration
Get the maximum number of iterations allowed before exiting the optimization procedure.

Specified by:
maxIterations in interface IOptimizerConfiguration
Overrides:
maxIterations in class AbstractOptimizerConfiguration
Returns:
The maximum number of iterations.

setUseFunctionGradient

public void setUseFunctionGradient(boolean useFG)
Description copied from class: AbstractOptimizerConfiguration
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:
useFG - true if the Optimizer has to use the IFunction's calculation of the gradient, false otherwise.

setStrategy

public void setStrategy(int strategy)
Description copied from class: AbstractOptimizerConfiguration
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.

strategy

public int strategy()
Description copied from class: AbstractOptimizerConfiguration
Get the strategy used by the optimizer in the optimization procedure.

Specified by:
strategy in interface IOptimizerConfiguration
Overrides:
strategy in class AbstractOptimizerConfiguration
Returns:
The strategy.

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.

setPrecision

public void setPrecision(double precision)
Description copied from class: AbstractOptimizerConfiguration
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.

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.