GModelPar.cpp
13.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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
/***************************************************************************
* GModelPar.cpp - Model parameter class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2013 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 GModelPar.cpp
* @brief GModelPar class implementation.
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GException.hpp"
#include "GModelPar.hpp"
#include "GTools.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_CONSTRUCT "GModelPar::GModelPar(std::string&, double&, double&)"
#define G_FACTOR_VALUE "GModelPar::factor_value(double&)"
#define G_FACTOR_MIN "GModelPar::factor_min(double&)"
#define G_FACTOR_MAX "GModelPar::factor_max(double&)"
#define G_SCALE "GModelPar::scale(double&)"
#define G_READ "GModelPar::read(GXmlElement&)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GModelPar::GModelPar(void) : GOptimizerPar()
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Parameter constructor
*
* @param[in] name Parameter name.
* @param[in] value Parameter value.
*
* Constructs a parameter from a parameter @p name and a parameter @p value.
*
* The parameter is auto-scaled, which for a @p value that differs from zero
* sets the scale factor to @p value and the @p factor_value to unity. For a
* @p value of zero, the scale factor will be set to unity and the
* @p factor_value will be set to @p value.
***************************************************************************/
GModelPar::GModelPar(const std::string& name, const double& value) :
GOptimizerPar(name, value)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Parameter constructor
*
* @param[in] name Parameter name.
* @param[in] factor Parameter value factor.
* @param[in] scale Parameter scaling (non-zero value).
*
* @exception GException::invalid_argument
* Sacle factor of 0 specified.
*
* Constructs a parameter from a parameter @p name, value @p factor
* and @p scale factor. The @p scale factor needs to be a non-zero value.
* If the @p scale factor is zero, an exception is thrown.
***************************************************************************/
GModelPar::GModelPar(const std::string& name,
const double& factor,
const double& scale) :
GOptimizerPar(name, factor, scale)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] par Model parameter.
***************************************************************************/
GModelPar::GModelPar(const GModelPar& par) : GOptimizerPar(par)
{
// Initialise members
init_members();
// Copy members
copy_members(par);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GModelPar::~GModelPar(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] par Model parameter.
* @return Model parameter.
***************************************************************************/
GModelPar& GModelPar::operator=(const GModelPar& par)
{
// Execute only if object is not identical
if (this != &par) {
// Copy base class members
this->GOptimizerPar::operator=(par);
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(par);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clone model parameter
*
* @return Pointer to deep copy of model parameter.
***************************************************************************/
GModelPar* GModelPar::clone(void) const
{
// Clone model parameter
return new GModelPar(*this);
}
/***********************************************************************//**
* @brief Extract parameter attributes from XML element
*
* @param[in] xml XML element
*
* @exception GException::invalid_value
* Invalid combination of parameter attributes encountered.
*
* Extracts the parameter attributes from an XML element of the form
*
* <parameter name=".." value=".." error=".." scale=".." min=".." max="..' free="..">
*
* Each of the attributes are optional, with the following scheme for
* assigning default values in case that the attribute was not found:
* - @p value sets @p m_factor_value (defaults to 0.0)
* - @p error sets @p m_factor_error (defaults to 0.0)
* - @p scale sets @p m_scale (defaults to 1.0)
* - @p min sets @p m_factor_min (will remove_min() if not found)
* - @p max sets @p m_factor_max (will remove_max() if not found)
* - @p free sets @p m_free (papameter will be fixed if not found)
***************************************************************************/
void GModelPar::read(const GXmlElement& xml)
{
// Get value
std::string arg = xml.attribute("value");
if (arg != "") {
m_factor_value = gammalib::todouble(arg);
}
else {
m_factor_value = 0.0;
}
// Get error
arg = xml.attribute("error");
if (arg != "") {
m_factor_error = gammalib::todouble(arg);
}
else {
m_factor_error = 0.0;
}
// Get scale factor
arg = xml.attribute("scale");
if (arg != "") {
m_scale = gammalib::todouble(arg);
}
else {
m_scale = 1.0;
}
// Get min
arg = xml.attribute("min");
if (arg != "") {
m_factor_min = gammalib::todouble(arg);
m_has_min = true;
}
else {
remove_min();
}
// Get max
arg = xml.attribute("max");
if (arg != "") {
m_factor_max = gammalib::todouble(arg);
m_has_max = true;
}
else {
remove_max();
}
// Get free
if (xml.attribute("free") == "1" ||
gammalib::tolower(xml.attribute("free")) == "true") {
free();
}
else {
fix();
}
// If there is a minimum and maximum, make sure that the maximum is
// not smaller than the minimum
if (m_has_min && m_has_max) {
if (m_factor_min > m_factor_max) {
std::string msg = "The model parameter \""+m_name+
"\" in the XML document has a minimum boundary "+
gammalib::str(m_factor_min)+
" that is larger than the maximum boundary "+
gammalib::str(m_factor_max)+".\n"+xml.print();
throw GException::invalid_value(G_READ, msg);
}
}
// If there is a minimum, make sure that the value is not below it
if (m_has_min && m_factor_value < m_factor_min) {
std::string msg = "The model parameter \""+m_name+
"\" in the XML document has a value "+
gammalib::str(m_factor_value)+
" that is smaller than the minimum boundary "+
gammalib::str(m_factor_min)+".\n"+xml.print();
throw GException::invalid_value(G_READ, msg);
}
// If there is a maximum, make sure that the value is not above it
if (m_has_max && m_factor_value > m_factor_max) {
std::string msg = "The model parameter \""+m_name+
"\" in the XML document has a value "+
gammalib::str(m_factor_value)+
" that is larger than the maximum boundary "+
gammalib::str(m_factor_max)+".\n"+xml.print();
throw GException::invalid_value(G_READ, msg);
}
// Return
return;
}
/***********************************************************************//**
* @brief Set or update parameter attributes in XML element
*
* @param[in] xml XML element.
*
* Sets or updates the parameter attributes in an XML element of the form
*
* <parameter name=".." value=".." error=".." scale=".." min=".." max="..' free="..">
*
* The following attributes will be set:
* - @p value
* - @p error (only in case that the parameter is free)
* - @p scale
* - @p min (only in case that a minimum exists)
* - @p max (only in case that a maximum exists)
* - @p free
***************************************************************************/
void GModelPar::write(GXmlElement& xml) const
{
// Set value
xml.attribute("value", gammalib::str(m_factor_value));
// Set error (only if parameter is free)
if (is_free()) {
xml.attribute("error", gammalib::str(m_factor_error));
}
// Set scale
xml.attribute("scale", gammalib::str(m_scale));
// Set minimum
if (has_min()) {
xml.attribute("min", gammalib::str(m_factor_min));
}
// Set maximum
if (has_max()) {
xml.attribute("max", gammalib::str(m_factor_max));
}
// Set free/fix flag
if (is_free()) {
xml.attribute("free", "1");
}
else {
xml.attribute("free", "0");
}
// Return
return;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GModelPar::init_members(void)
{
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] par Model parameter.
***************************************************************************/
void GModelPar::copy_members(const GModelPar& par)
{
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GModelPar::free_members(void)
{
// Return
return;
}