sventon subversion web client - http://www.sventon.org
[show recent changes]
 
  Help
HEAD
Rev: 10093 - svn://svn.freehep.org/svn / freehep / cvs / aidainclude / tags / AIDA-33-BRANCH-pre-merge-1 / AIDA / IFitParameterSettings.h
Show File - IFitParameterSettings.h  [show properties]
Search for Help
spinner
// -*- C++ -*-
// AID-GENERATED
// =========================================================================
// This class was generated by AID - Abstract Interface Definition
// DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
// =========================================================================
#ifndef AIDA_IFITPARAMETERSETTINGS_H
#define AIDA_IFITPARAMETERSETTINGS_H 1
10  // This file is part of the AIDA library
11  // Copyright (C) 2002 by the AIDA team. All rights reserved.
12  // This library is free software and under the terms of the
13  // GNU Library General Public License described in the LGPL.txt
14 
15  #include <string>
16 
17  namespace AIDA {
18 
19  /** @interface
20   *
21   * Fitting-specific settings applied to a parameter of the fitted function.
22   *
23   * @author The AIDA team (http://aida.freehep.org/)
24   *
25   */
26 
27  class IFitParameterSettings {
28 
29  public:
30      /// Destructor.
31      virtual ~IFitParameterSettings() { /* nop */; }
32 
33    /// Name of the parameter to which settings apply.
34      virtual std::string name() const = 0;
35 
36    /// Step size allows to control the "sensitivity" of the change of the parameter
37    /// when fitters looks for the optimal parameter value. Default is 1.0.
38      virtual double stepSize() const = 0;
39 
40    /// Bounds.
41      virtual double upperBound() const = 0;
42 
43      virtual double lowerBound() const = 0;
44 
45    /// Shortcut for lowerBound() == -INF && upperBound() == +INF.
46      virtual bool isBound() const = 0;
47 
48    /// Value of the parameter cannot change if isFixed() == true.
49    /// Parameter can be fixed independently from setting the bounds.
50      virtual bool isFixed() const = 0;
51 
52    /// Set the step size for the fitter.
53      virtual void setStepSize(double step) = 0;
54 
55    /// Set bounds. If bounds not set, then default bound is (-INF,+INF).
56      virtual void setBounds(double lo, double up) = 0;
57 
58    /// Shortcut for setBounds(-INF,+INF).
59      virtual void removeBounds() = 0;
60 
61    /// Fix/unfix parameter.
62      virtual void setFixed(bool isFixed) = 0;
63 
64    /**
65     * Set the lower bound. When this method is
66     * invoked any previous bound is reset. The new bounds
67     * are (lowerBound, +INF).
68     * @param lowerBound The lower bound.
69     *
70     */
71      virtual void setLowerBound(double lowerBound) = 0;
72 
73    /**
74     * Set the upper bound. When this method is
75     * invoked any previous bound is reset. The new bounds
76     * are (-INF, upperBound).
77     * @param upperBound The upper bound.
78     *
79     */
80      virtual void setUpperBound(double upperBound) = 0;
81 
82    /// Reset all settings to the default values (remove bounds, step size = 1.0, no fix).
83      virtual void reset() = 0;
84  }; // class
85  } // namespace AIDA
86  #endif /* ifndef AIDA_IFITPARAMETERSETTINGS_H */


feed icon

sventon 2.5.1