laura is hosted by Hepforge, IPPP Durham
Laura++  3.6.0
A maximum likelihood fitting package for performing Dalitz-plot analysis.
LauAbsRValue.hh
Go to the documentation of this file.
1 
2 /*
3 Copyright 2014 University of Warwick
4 
5 Licensed under the Apache License, Version 2.0 (the "License");
6 you may not use this file except in compliance with the License.
7 You may obtain a copy of the License at
8 
9  http://www.apache.org/licenses/LICENSE-2.0
10 
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS,
13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
16 */
17 
18 /*
19 Laura++ package authors:
20 John Back
21 Paul Harrison
22 Thomas Latham
23 */
24 
36 #ifndef LAU_ABSRVALUE
37 #define LAU_ABSRVALUE
38 
39 #include "TString.h"
40 
41 #include <vector>
42 
43 class LauParameter;
44 
45 class LauAbsRValue {
46 
47  public:
50 
52  virtual ~LauAbsRValue() {}
53 
55  LauAbsRValue( const LauAbsRValue& /*rhs*/ ) {}
56 
58  LauAbsRValue& operator=( const LauAbsRValue& /*rhs*/ ) { return *this; }
59 
61 
64  virtual const TString& name() const = 0;
65 
67 
70  virtual void name( const TString& newName ) = 0;
71 
73 
76  virtual Double_t value() const = 0;
77 
79 
82  virtual Double_t unblindValue() const = 0;
83 
85 
88  virtual Double_t genValue() const = 0;
89 
91 
94  virtual Double_t initValue() const = 0;
95 
97 
100  virtual Bool_t gaussConstraint() const = 0;
101 
103 
106  virtual Double_t constraintPenalty() const = 0;
107 
109  virtual void generateConstraintMean() = 0;
110 
112 
115  virtual std::vector<LauParameter*> getPars() = 0;
116 
118 
121  virtual Bool_t isLValue() const = 0;
122 
124 
127  virtual Bool_t fixed() const = 0;
128 
130 
133  virtual Bool_t blind() const = 0;
134 
135  private:
136  ClassDef( LauAbsRValue, 1 ) // Abstract base class for R parameters
137 };
138 
139 #endif
Class for defining the fit parameter objects.
Definition: LauParameter.hh:49
virtual Bool_t blind() const =0
The blinding state.
virtual Double_t value() const =0
Return the value of the parameter.
virtual std::vector< LauParameter * > getPars()=0
Return the list of LauParameters on which the LauAbsRValue depends.
virtual Double_t initValue() const =0
The initial value of the parameter.
virtual Double_t unblindValue() const =0
The unblinded value of the parameter.
virtual void name(const TString &newName)=0
Set the parameter name.
LauAbsRValue & operator=(const LauAbsRValue &)
Copy assignment operator.
Definition: LauAbsRValue.hh:58
LauAbsRValue()
Constructor.
Definition: LauAbsRValue.hh:49
virtual Double_t constraintPenalty() const =0
The penalty term from the Gaussian constraint.
Pure abstract base class for defining a parameter containing an R value.
Definition: LauAbsRValue.hh:45
virtual Bool_t fixed() const =0
Check is the parameter is fixed or floated.
virtual Bool_t gaussConstraint() const =0
Check whether a Gaussian constraints is applied.
LauAbsRValue(const LauAbsRValue &)
Copy constructor.
Definition: LauAbsRValue.hh:55
virtual Double_t genValue() const =0
The value generated for the parameter.
virtual ~LauAbsRValue()
Destructor.
Definition: LauAbsRValue.hh:52
virtual Bool_t isLValue() const =0
Is the parameter also an L value or not.
virtual void generateConstraintMean()=0
Generate per-experiment constraint mean.
virtual const TString & name() const =0
Return the name of the parameter.