GResponseCache.hpp
5.67 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
/***************************************************************************
* GResponseCache.hpp - Response cache class *
* ----------------------------------------------------------------------- *
* copyright (C) 2020 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 GResponseCache.hpp
* @brief Response cache class definition
* @author Juergen Knoedlseder
*/
#ifndef GRESPONSECACHE_HPP
#define GRESPONSECACHE_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include <cstdint>
#include <map>
#include "GBase.hpp"
#include "GEnergy.hpp"
/* __ Forward declarations _______________________________________________ */
class GInstDir;
/* __ Constants __________________________________________________________ */
/* __ Typedefs ___________________________________________________________ */
typedef std::map<uint64_t,double> GResponseCacheDir;
typedef std::map<uint64_t,GResponseCacheDir> GResponseCacheEnergy;
typedef std::map<std::string,GResponseCacheEnergy> GResponseCacheName;
/***********************************************************************//**
* @class GResponseCache
*
* @brief Response cache class
*
* The class implements a cache for the Instrument Response Function values
* so that the values do not need to be recomputed each time but can be
* fetched from the cache.
***************************************************************************/
class GResponseCache : public GBase {
public:
// Constructors and destructors
GResponseCache(void);
GResponseCache(const GResponseCache& cache);
virtual ~GResponseCache(void);
// Operators
GResponseCache& operator=(const GResponseCache& cache);
// Methods
void clear(void);
GResponseCache* clone(void) const;
std::string classname(void) const;
bool is_empty(void) const;
int size(void) const;
int nenergies(void) const;
void set(const std::string& name,
const GEnergy& ereco,
const GEnergy& etrue,
const double& value);
void set(const std::string& name,
const GInstDir& dir,
const GEnergy& ereco,
const GEnergy& etrue,
const double& value);
void remove(const std::string& name);
bool contains(const std::string& name,
const GEnergy& ereco,
const GEnergy& etrue,
double* value = NULL) const;
bool contains(const std::string& name,
const GInstDir& dir,
const GEnergy& ereco,
const GEnergy& etrue,
double* value = NULL) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GResponseCache& cache);
void free_members(void);
uint64_t hash(const GEnergy& ereco, const GEnergy& etrue) const;
// Protected members
GResponseCacheName m_cache; //<! Response cache
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GResponseCache").
***************************************************************************/
inline
std::string GResponseCache::classname(void) const
{
return ("GResponseCache");
}
/***********************************************************************//**
* @brief Checks whether the cache is empty
*
* @return True if cache is empty, false otherwise.
*
* Checks whether the response cache is empty.
***************************************************************************/
inline
bool GResponseCache::is_empty(void) const
{
return (m_cache.empty());
}
/***********************************************************************//**
* @brief Remove cache for source
*
* @param[in] name Source name.
*
* Remove cache for source with @p name.
***************************************************************************/
inline
void GResponseCache::remove(const std::string& name)
{
m_cache.erase(name);
return;
}
#endif /* GRESPONSECACHE_HPP */