RAIDA  1.9.0
IFitResult.h
1 // -*- C++ -*-
2 // AID-GENERATED
3 // =========================================================================
4 // This class was generated by AID - Abstract Interface Definition
5 // DO NOT MODIFY, but use the org.freehep.aid.Aid utility to regenerate it.
6 // =========================================================================
7 #ifndef AIDA_IFITRESULT_H
8 #define AIDA_IFITRESULT_H 1
9 
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 #include <vector>
17 
18 namespace AIDA {
19 
20 class IFitParameterSettings;
21 class IFunction;
22 
35 class IFitResult {
36 
37 public:
39  virtual ~IFitResult() { /* nop */; }
40 
42  virtual bool isValid() = 0;
43 
45  virtual int fitStatus() = 0;
46 
48  virtual IFunction & fittedFunction() = 0;
49 
52  virtual double quality() = 0;
53 
55  virtual int ndf() = 0;
56 
58  virtual double covMatrixElement(int i, int j) = 0;
59 
61  virtual std::string fitMethodName() = 0;
62 
64  virtual std::string engineName() = 0;
65 
71  virtual std::string dataDescription() = 0;
72 
74  virtual std::vector<std::string> constraints() = 0;
75 
77  virtual IFitParameterSettings * fitParameterSettings(const std::string & name) = 0;
78 
84  virtual const std::vector<double> & fittedParameters() const = 0;
85 
91  virtual std::vector<std::string> fittedParameterNames() const = 0;
92 
98  virtual double fittedParameter(const std::string & name) = 0;
99 
106  virtual const std::vector<double> & errors() const = 0;
107 
114  virtual const std::vector<double> & errorsPlus() const = 0;
115 
122  virtual const std::vector<double> & errorsMinus() const = 0;
123 
126  /*# IFitParameterSettings lnkIFitParameterProperty; */
127 }; // class
128 } // namespace AIDA
129 #endif /* ifndef AIDA_IFITRESULT_H */
Principal user-level function interface.
Definition: IFunction.h:35
virtual ~IFitResult()
Destructor.
Definition: IFitResult.h:39
virtual const std::vector< double > & fittedParameters() const =0
Get the array of the fitted parameter values (including fixed and constrained ones).
virtual double quality()=0
Quality of the fit.
virtual double fittedParameter(const std::string &name)=0
Get the value of a fitted parameter by name.
virtual const std::vector< double > & errors() const =0
Get the parabolic errors on the fitted parameters.
virtual const std::vector< double > & errorsPlus() const =0
Get the positive part of the asymmetric errors on the fitted parameters.
virtual std::string fitMethodName()=0
Fit method name as set in the fitter.
virtual int fitStatus()=0
Status of the fit. PENDING: what are the suggested values?
Definition: IFitParameterSettings.h:27
virtual std::vector< std::string > fittedParameterNames() const =0
Get the names of the fitted parameters (including fixed and constrained ones).
virtual bool isValid()=0
True if fit successful, otherwise false.
Definition: IFitResult.h:35
virtual std::string dataDescription()=0
Textual description of data - this is a hint for the user how to find the data in the tree if he want...
virtual std::string engineName()=0
Engine used to do fitting.
virtual IFitParameterSettings * fitParameterSettings(const std::string &name)=0
Access to applied parameter settings.
virtual IFunction & fittedFunction()=0
Fitted function. The parameters hold the results of the fit.
virtual std::vector< std::string > constraints()=0
Vector of constraints.
virtual const std::vector< double > & errorsMinus() const =0
Get the negative part of the asymmetric errors on the fitted parameters.
virtual double covMatrixElement(int i, int j)=0
Covariance matrix. PENDING: interface for matrix to be defined.
virtual int ndf()=0
Number of degrees of freedom.