GModels.hpp
10.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
/***************************************************************************
* GModels.hpp - Model container class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2016 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GModels.hpp
* @brief Model container class definition
* @author Juergen Knoedlseder
*/
#ifndef GMODELS_HPP
#define GMODELS_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GContainer.hpp"
#include "GModel.hpp"
#include "GOptimizerPars.hpp"
#include "GXml.hpp"
/* __ Forward declarations _______________________________________________ */
class GEvent;
class GObservation;
class GFilename;
/***********************************************************************//**
* @class GModels
*
* @brief Model container class
*
* This container class collects models of type GModel that are used to
* describe the data. The names of all models in the container have to be
* unique, i.e. every name can occur only once. This allows for accessing the
* models by name and by index.
*
* The GModels class provides methods to manage and to access the models
* in the container. The number of models in the container is retrieved
* using the size() method. The is_empty() method can be used to check
* whether the container is empty or whether it contains models:
*
* GModels models; // Allocate container
* int n = models.size(); // Number of models in container
* if (models.is_empty()) // Check for emptiness
* std::cout << "Empty container";
*
* Access operators exist for accessing of models by index or by name:
*
* GModel* mptr = models[i]; // Get i'th model
* GModel* mptr = models["Crab"]; // Get a model named "Crab"
*
* The index access operator does not check the validity of the provided
* index. For index validation, use the at() method:
*
* GModel* mptr = models.at(i); // Get i'th model with index check
*
* The append() method add a model to the container:
*
* models.append(model); // Append model
*
* The append() method clones the model that is passed as argument. The
* method returns a pointer to the cloned model so that the attributes of
* the cloned model can be manipulated:
*
* GModel* mptr = models.append(model);
*
* The insert() methods insert a model before a given index or before
* a model with a given name (the methods also return a pointer to the
* cloned model):
*
* models.insert(i, model); // Insert before i'th model
* models.insert("Crab", model); // Insert before "Crab" model
*
* The set() methods replace an existing model by index or by name (also
* these methods return a pointer to the cloned model):
*
* models.set(i, model); // Replace i'th model
* models.set("Crab", model); // Replace "Crab" model
*
* The remove() methods remove an existing model by index or by name:
*
* models.remove(i); // Remove i'th model
* models.remove("Crab"); // Remove "Crab" model
*
* The existence of a model with a given name can be checked using
*
* if (models.contains("Crab"))
* std::cout << "We have the Crab!";
*
* The extend() method extends a container by all models found in another
* container:
*
* models.extend(other_models); // Extend container
*
* For repeated container manipulations, a given @p number of model slots can
* be reserved using
*
* models.reserve(number); // Reserves model slots
*
* which will speed up the memory allocations for new models.
*
* Models can be saved into or loaded from an XML file using
*
* models.save("mymodels.xml"); // Save models in XML file
* models.load("mymodels.xml"); // Load models from XML file
*
* The models can also be loaded upon construction from an XML file:
*
* GModels models("mymodels.xml"); // Construct by loading models from XML file
*
* The class can also directly operate on a GXml object using the read() and
* write() methods:
*
* GXml xml; // Allocate GXml object
* models.write(xml); // Write into GXml object
* models.read(xml); // Read models from GXml object
*
* The sum of all models in the container are evaluated for a given @p event
* and @p observation using the eval() method:
*
* double value = models.eval(event, observation);
*
* If the eval() method is called with the optional gradients parameter set
* to true, i.e.
*
* double value = models.eval(event, observation, true);
*
* the method computes also the parameter gradients for all free model
* parameters that have an analytical parameter gradient.
*
* The only member of GModels is a list of model pointers. The class handles
* the proper allocation and deallocation of the model memory.
***************************************************************************/
class GModels : public GContainer {
public:
// Constructors and destructors
GModels(void);
GModels(const GModels& models);
explicit GModels(const GFilename& filename);
virtual ~GModels(void);
// Operators
GModels& operator=(const GModels& models);
GModel* operator[](const int& index);
const GModel* operator[](const int& index) const;
GModel* operator[](const std::string& name);
const GModel* operator[](const std::string& name) const;
// Methods
void clear(void);
GModels* clone(void) const;
std::string classname(void) const;
GModel* at(const int& index);
const GModel* at(const int& index) const;
int size(void) const;
bool is_empty(void) const;
GModel* set(const int& index, const GModel& model);
GModel* set(const std::string& name, const GModel& model);
GModel* append(const GModel& model);
GModel* insert(const int& index, const GModel& model);
GModel* insert(const std::string& name, const GModel& model);
void remove(const int& index);
void remove(const std::string& name);
void reserve(const int& num);
void extend(const GModels& models);
bool contains(const std::string& name) const;
void load(const GFilename& filename);
void save(const GFilename& filename) const;
void read(const GXml& xml);
void write(GXml& xml) const;
int npars(void) const;
GOptimizerPars pars(void) const;
double eval(const GEvent& event,
const GObservation& obs,
const bool& gradients = false) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GModels& models);
void free_members(void);
int get_index(const std::string& name) const;
// Proteced members
std::vector<GModel*> m_models; //!< List of models
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GModels").
***************************************************************************/
inline
std::string GModels::classname(void) const
{
return ("GModels");
}
/***********************************************************************//**
* @brief Return pointer to model
*
* @param[in] index Model index [0,...,size()-1].
*
* Returns a pointer to the model with the specified @p index.
***************************************************************************/
inline
GModel* GModels::operator[](const int& index)
{
return (m_models[index]);
}
/***********************************************************************//**
* @brief Return pointer to model (const version)
*
* @param[in] index Model index [0,...,size()-1].
*
* Returns a const pointer to the model with the specified @p index.
***************************************************************************/
inline
const GModel* GModels::operator[](const int& index) const
{
return (m_models[index]);
}
/***********************************************************************//**
* @brief Return number of models in container
*
* @return Number of models in container.
*
* Returns the number of models in the model container.
***************************************************************************/
inline
int GModels::size(void) const
{
return (int)m_models.size();
}
/***********************************************************************//**
* @brief Signals if there are no models in container
*
* @return True if container is empty, false otherwise.
*
* Signals if the model container does not contain any model.
***************************************************************************/
inline
bool GModels::is_empty(void) const
{
return (m_models.empty());
}
/***********************************************************************//**
* @brief Reserves space for models in container
*
* @param[in] num Number of models
*
* Reserves space for @p num models in the container.
***************************************************************************/
inline
void GModels::reserve(const int& num)
{
m_models.reserve(num);
return;
}
#endif /* GMODELS_HPP */