English Français

Documentation / Manuel développeur

Modules disponibles

Calibration,  DataServer,  Launcher,  MetaModelOptim,  Modeler,  Optimizer,  ReLauncher,  Reliability,  ReOptimizer,  Sampler,  Sensitivity,  UncertModeler,  XmlProblem,   Uranie / Modeler: TCorrelationFunction.h Source File
Uranie / Modeler v4.9.0
/* @license-end */
TCorrelationFunction.h
Go to the documentation of this file.
1
2// Copyright (C) 2013-2024 CEA/DES
3//
4// This program is free software: you can redistribute it and/or modify
5// it under the terms of the GNU Lesser General Public License as published
6// by the Free Software Foundation, either version 3 of the License, or any
7// later version.
8//
9// This program is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU Lesser General Public License for more details.
13//
14// You should have received a copy of the GNU Lesser General Public License
15// along with this program. If not, see <http://www.gnu.org/licenses/>.
18// $Id$
19// $Author$
20// $Date$
21// $Revision$
22// $State$
24
41#ifndef TCORRELATIONFUNCTION_H
42#define TCORRELATIONFUNCTION_H
43
44#include "TNamed.h"
45#include "Modeler.h"
46#include "UExceptions.h"
47
48namespace URANIE
49{
50 namespace Modeler
51 {
52 class TCorrelationFunction: public TNamed
53 {
54
55 // Attributes
56 private:
57 public:
58 Bool_t _blog;
59 Double_t* parameters;
60 Double_t* _lCorrLengths;
64
65 // Operations
66 public:
67 //---------------------------------------------
71
75
79
80 //---------------------------------------------
84
86 {
87 return nbParameters;
88 }
89
92 {
93 return nbDimensions;
94 }
95
98 {
99 return nbCorrLengths;
100 }
101
103 Double_t* getParameters()
104 {
105 return parameters;
106 }
107
109 Double_t* getCorrLengths()
110 {
111 return _lCorrLengths;
112 }
113
115
121 virtual void setParameters(Double_t* newParams) = 0;
122
124
127 virtual void setCorrLengths(Double_t *corrLength) = 0;
128
130
131 //---------------------------------------------
135
140
142
165 virtual void eval(Int_t n1, Double_t* x1, Int_t n2, Double_t* x2, Double_t* C) = 0;
166
168
169 //---------------------------------------------
173 void setLog()
174 {
175 _blog = kTRUE;
176 }
177
178 void unsetLog()
179 {
180 _blog = kFALSE;
181 }
182
184 {
185 _blog = !_blog;
186 }
187
188 Bool_t getLog()
189 {
190 return _blog;
191 }
192
193 virtual void printLog(Option_t *option = "");
195
196 ClassDef(URANIE::Modeler::TCorrelationFunction, ID_MODELER)
197 //Classe de
198 };
199
200 } // Fin du namespace Modeler
201} // Fin du namespace URANIE
202#endif
Description of the class TCorrelationFunction.
Definition TCorrelationFunction.h:53
Double_t * parameters
array containing the values of the function parameters. Correlation lengths are stored last.
Definition TCorrelationFunction.h:59
Int_t nbDimensions
number of dimensions of the input space
Definition TCorrelationFunction.h:61
TCorrelationFunction()
Default constructor.
void changeLog()
Definition TCorrelationFunction.h:183
virtual void setParameters(Double_t *newParams)=0
Set the values of the function's parameters.
Int_t getNDimensions()
Return the number of dimensions of the input space.
Definition TCorrelationFunction.h:91
Bool_t _blog
Boolean to decide if the log information is shown or not.
Definition TCorrelationFunction.h:58
virtual void setCorrLengths(Double_t *corrLength)=0
Sets the values of the correlation lengths.
Int_t getNParameters()
Return the number of parameters of the correlation function.
Definition TCorrelationFunction.h:85
void setLog()
Definition TCorrelationFunction.h:173
virtual void printLog(Option_t *option="")
Double_t * getParameters()
Returns an array containing the parameters of the function.
Definition TCorrelationFunction.h:103
virtual void eval(Int_t n1, Double_t *x1, Int_t n2, Double_t *x2, Double_t *C)=0
Compute the correlation between x1 and x2.
Bool_t getLog()
Definition TCorrelationFunction.h:188
virtual ~TCorrelationFunction()
Default destructor.
void unsetLog()
Definition TCorrelationFunction.h:178
Int_t nbParameters
total number of parameters
Definition TCorrelationFunction.h:62
Int_t getNCorrLengths()
Return the number of correlation lengths.
Definition TCorrelationFunction.h:97
Int_t nbCorrLengths
number of correlation lengths
Definition TCorrelationFunction.h:63
virtual TCorrelationFunction * clone()=0
Return a clone of the correlation function.
Double_t * _lCorrLengths
array containing only the correlation lengths.
Definition TCorrelationFunction.h:60
Double_t * getCorrLengths()
Returns an array containing only the correlation lengths.
Definition TCorrelationFunction.h:109
ROOT.
Definition TAnisp.h:164