GTimes.cpp
12.5 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
412
/***************************************************************************
* GTimes.cpp - Time container class *
* ----------------------------------------------------------------------- *
* copyright (C) 2012-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 GTimes.cpp
* @brief Time container class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GTools.hpp"
#include "GException.hpp"
#include "GTimes.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_OP_ACCESS "GTimes::operator[](int&)"
#define G_INSERT "GTimes::insert(int&, GTime&)"
#define G_REMOVE "GTimes::remove(int&)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GTimes::GTimes(void)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param times Photon container.
***************************************************************************/
GTimes::GTimes(const GTimes& times)
{
// Initialise members
init_members();
// Copy members
copy_members(times);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GTimes::~GTimes(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] times Time container.
* @return Time container.
***************************************************************************/
GTimes& GTimes::operator=(const GTimes& times)
{
// Execute only if object is not identical
if (this != ×) {
// Free members
free_members();
// Initialise members
init_members();
// Copy members
copy_members(times);
} // endif: object was not identical
// Return this object
return *this;
}
/***********************************************************************//**
* @brief Return reference to time
*
* @param[in] index Index of time [0,...,size()-1]
*
* @exception GException::out_of_range
* Time index is out of range.
***************************************************************************/
GTime& GTimes::operator[](const int& index)
{
// If index is outside boundary then throw an error
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= size()) {
throw GException::out_of_range(G_OP_ACCESS, index, 0, size()-1);
}
#endif
// Return reference
return m_times[index];
}
/***********************************************************************//**
* @brief Return reference to time (const version)
*
* @param[in] index Index of time [0,...,size()-1]
*
* @exception GException::out_of_range
* Time index is out of range.
***************************************************************************/
const GTime& GTimes::operator[](const int& index) const
{
// If index is outside boundary then throw an error
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= size()) {
throw GException::out_of_range(G_OP_ACCESS, index, 0, size()-1);
}
#endif
// Return reference
return m_times[index];
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear container
***************************************************************************/
void GTimes::clear(void)
{
// Free members
free_members();
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone object
*
* @return Pointer to deep copy of time container.
***************************************************************************/
GTimes* GTimes::clone(void) const
{
return new GTimes(*this);
}
/***********************************************************************//**
* @brief Append time to container
*
* @param[in] time Time.
*
* This method appends a time to the container by copying it.
***************************************************************************/
void GTimes::append(const GTime& time)
{
// Append time to list
m_times.push_back(time);
// Return
return;
}
/***********************************************************************//**
* @brief Insert time into container
*
* @param[in] index Time index (0,...,size()-1).
* @param[in] time Time.
*
* @exception GException::out_of_range
* Time index is out of range.
*
* Inserts a @p time into the container before the time with the specified
* @p index.
***************************************************************************/
void GTimes::insert(const int& index, const GTime& time)
{
// Compile option: raise exception if index is out of range
#if defined(G_RANGE_CHECK)
if (is_empty()) {
if (index > 0) {
throw GException::out_of_range(G_INSERT, index, 0, size()-1);
}
}
else {
if (index < 0 || index >= size()) {
throw GException::out_of_range(G_INSERT, index, 0, size()-1);
}
}
#endif
// Inserts time
m_times.insert(m_times.begin()+index, time);
// Return
return;
}
/***********************************************************************//**
* @brief Remove time from container
*
* @param[in] index Time index (0,...,size()-1).
*
* @exception GException::out_of_range
* Time index is out of range.
*
* Remove time of specified @p index from container.
***************************************************************************/
void GTimes::remove(const int& index)
{
// Compile option: raise exception if index is out of range
#if defined(G_RANGE_CHECK)
if (index < 0 || index >= size()) {
throw GException::out_of_range(G_REMOVE, index, 0, size()-1);
}
#endif
// Erase time from container
m_times.erase(m_times.begin() + index);
// Return
return;
}
/***********************************************************************//**
* @brief Append time container
*
* @param[in] times Time container.
*
* Append time container to the container.
***************************************************************************/
void GTimes::extend(const GTimes& times)
{
// Do nothing if time container is empty
if (!times.is_empty()) {
// Get size. Note that we extract the size first to avoid an
// endless loop that arises when a container is appended to
// itself.
int num = times.size();
// Reserve enough space
reserve(size() + num);
// Loop over all elements and append them to container
for (int i = 0; i < num; ++i) {
m_times.push_back(times[i]);
}
} // endif: time container was not empty
// Return
return;
}
/***********************************************************************//**
* @brief Reserve memory for times in container
*
* @param[in] num Number of times.
*
* This method reserves memory for @p num times in the container.
***************************************************************************/
void GTimes::reserve(const int& num)
{
// Reserve memory
m_times.reserve(num);
// Return
return;
}
/***********************************************************************//**
* @brief Print time container information
*
* @param[in] chatter Chattiness (defaults to NORMAL).
* @return String containing time container information.
***************************************************************************/
std::string GTimes::print(const GChatter& chatter) const
{
// Initialise result string
std::string result;
// Continue only if chatter is not silent
if (chatter != SILENT) {
// Append header
result.append("=== GTimes ===");
// Append time container information
result.append("\n"+gammalib::parformat("Number of times"));
result.append(gammalib::str(size()));
// EXPLICIT: Append times
if (chatter >= EXPLICIT) {
for (int i = 0; i < size(); ++i) {
result.append("\n"+m_times[i].print(chatter));
}
}
} // endif: chatter was not silent
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GTimes::init_members(void)
{
// Initialise members
m_times.clear();
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] times Time container.
***************************************************************************/
void GTimes::copy_members(const GTimes& times)
{
// Copy attributes
m_times = times.m_times;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GTimes::free_members(void)
{
// Return
return;
}