FreeHEP API
Version current

hep.aida.ref.optimizer.uncmin
Class UncminOptimizerConfiguration

java.lang.Object
  extended byhep.aida.ref.optimizer.AbstractOptimizerConfiguration
      extended byhep.aida.ref.optimizer.uncmin.UncminOptimizerConfiguration
All Implemented Interfaces:
IOptimizerConfiguration

public class UncminOptimizerConfiguration
extends AbstractOptimizerConfiguration

Implementation of IOptimizerConfiguration for the Uncmin optimizer

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

Field Summary
static String DOUBLE_DOGLEG
           
static int HIGH_CALL_STRATEGY
           
static int HIGH_CALL_STRATEGY_CHECK
           
static String LINE_SEARCH
          The methods available in Uncmin.
static int LOW_CALL_STRATEGY
          The kind of strategies available in Uncmin.
static int LOW_CALL_STRATEGY_CHECK
           
static String MORE_HEBDON
           
 
Fields inherited from interface hep.aida.ext.IOptimizerConfiguration
CHI2_FIT_ERROR, DEFAULT_ERROR, DETAILED_OUTPUT, LOGL_FIT_ERROR, NO_OUTPUT, NORMAL_OUTPUT
 
Constructor Summary
UncminOptimizerConfiguration()
          Creates a new instance of UncminOptimizerConfiguration
 
Method Summary
 int errorDefinition()
          Get the optimizer's error definition.
 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 setStrategy(int strategy)
          Set the strategy to be used by the optimizer in the optimization procedure.
 
Methods inherited from class hep.aida.ref.optimizer.AbstractOptimizerConfiguration
maxIterations, method, precision, printLevel, setMaxIterations, setPrintLevel, setTitle, setTolerance, setUseFunctionGradient, setUseFunctionHessian, 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

LINE_SEARCH

public static final String LINE_SEARCH
The methods available in Uncmin.

See Also:
Constant Field Values

DOUBLE_DOGLEG

public static final String DOUBLE_DOGLEG
See Also:
Constant Field Values

MORE_HEBDON

public static final String MORE_HEBDON
See Also:
Constant Field Values

LOW_CALL_STRATEGY

public static final int LOW_CALL_STRATEGY
The kind of strategies available in Uncmin. With the LOW_CALL_STRATEGY (default) the Hessian is evaluated by secant update rather than analytically or by finite difference. The option with "_CHECK" enables some authomatic checks.

See Also:
Constant Field Values

HIGH_CALL_STRATEGY

public static final int HIGH_CALL_STRATEGY
See Also:
Constant Field Values

LOW_CALL_STRATEGY_CHECK

public static final int LOW_CALL_STRATEGY_CHECK
See Also:
Constant Field Values

HIGH_CALL_STRATEGY_CHECK

public static final int HIGH_CALL_STRATEGY_CHECK
See Also:
Constant Field Values
Constructor Detail

UncminOptimizerConfiguration

public UncminOptimizerConfiguration()
Creates a new instance of UncminOptimizerConfiguration

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.

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.

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.

setErrorDefinition

public void setErrorDefinition(int errorDefinition)
                        throws IllegalArgumentException
Description copied from class: AbstractOptimizerConfiguration
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.
Throws:
IllegalArgumentException

errorDefinition

public int errorDefinition()
Description copied from class: AbstractOptimizerConfiguration
Get the optimizer's error definition.

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

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.