GOptimizerPars.cpp
9.18 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
/***************************************************************************
* GOptimizerPars.cpp - Parameter container class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2011 by Jurgen Knodlseder *
* ----------------------------------------------------------------------- *
* *
* 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 GOptimizerPars.cpp
* @brief Optimizer parameter container class implementation
* @author J. Knodlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GException.hpp"
#include "GOptimizerPars.hpp"
#include "GTools.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_PAR "GOptimizerPars::par(int&)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GOptimizerPars::GOptimizerPars(void)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] pars Optimizer parameters.
***************************************************************************/
GOptimizerPars::GOptimizerPars(const GOptimizerPars& pars)
{
// Initialise members
init_members();
// Copy members
copy_members(pars);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GOptimizerPars::~GOptimizerPars()
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] pars Optimizer parameters.
***************************************************************************/
GOptimizerPars& GOptimizerPars::operator= (const GOptimizerPars& pars)
{
// Execute only if object is not identical
if (this != &pars) {
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(pars);
} // endif: object was not identical
// Return
return *this;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear object
***************************************************************************/
void GOptimizerPars::clear(void)
{
// Free class members
free_members();
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone instance
***************************************************************************/
GOptimizerPars* GOptimizerPars::clone(void) const
{
return new GOptimizerPars(*this);
}
/***********************************************************************//**
* @brief Returns number of free parameters
***************************************************************************/
int GOptimizerPars::nfree(void) const
{
// Initialise number of free parameters
int nfree = 0;
// Collect all free parameters
for (int i = 0; i < npars(); ++i) {
if (m_pars[i]->isfree())
nfree++;
}
// Return
return nfree;
}
/***********************************************************************//**
* @brief Returns reference to model parameter
*
* @param[in] index Parameter index [0,...,npars()-1]
*
* @exception GException::out_of_range
* Parameter index is out of range.
***************************************************************************/
GModelPar& GOptimizerPars::par(const int& index)
{
// Compile option: raise exception if index is out of range
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= npars())
throw GException::out_of_range(G_PAR, index, 0, npars()-1);
#endif
// Return parameter reference
return *(m_pars[index]);
}
/***********************************************************************//**
* @brief Returns reference to model parameter (const version)
*
* @param[in] index Parameter index [0,...,npars()-1]
*
* @exception GException::out_of_range
* Parameter index is out of range.
***************************************************************************/
const GModelPar& GOptimizerPars::par(const int& index) const
{
// Compile option: raise exception if index is out of range
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= npars())
throw GException::out_of_range(G_PAR, index, 0, npars()-1);
#endif
// Return parameter reference
return *(m_pars[index]);
}
/***********************************************************************//**
* @brief Print models
***************************************************************************/
std::string GOptimizerPars::print(void) const
{
// Initialise result string
std::string result;
// Append header
result.append("=== GOptimizerPars ===");
result.append("\n"+parformat("Number of parameters")+str(npars()));
for (int i = 0; i < npars(); ++i)
result.append("\n"+m_pars[i]->print());
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GOptimizerPars::init_members(void)
{
// Initialise members
m_pars.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] pars Optimizer parameters.
***************************************************************************/
void GOptimizerPars::copy_members(const GOptimizerPars& pars)
{
// Copy attributes
m_pars = pars.m_pars;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GOptimizerPars::free_members(void)
{
// Return
return;
}