GOptimizerPars.hpp
7.1 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
/***************************************************************************
* GOptimizerPars.hpp - Optimizer parameter container class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2015 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 GOptimizerPars.hpp
* @brief Optimizer parameters base class definition
* @author Juergen Knoedlseder
*/
#ifndef GOPTIMIZERPARS_HPP
#define GOPTIMIZERPARS_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GContainer.hpp"
#include "GOptimizerPar.hpp"
/***********************************************************************//**
* @class GOptimizerPars
*
* @brief Optimizer parameter container class
*
* This class is a container class for parameters of a function that are to
* be optimized. The optimizer function is defined by the abstract
* GOptimizerFunction class.
*
* The class holds a flat array of pointers to optimizer parameters. The
* class can deal with parameters that are allocated by the class itself,
* or with pointers that are passed by a client and allocated/deallocated
* by the client.
***************************************************************************/
class GOptimizerPars : public GContainer {
public:
// Constructors and destructors
GOptimizerPars(void);
explicit GOptimizerPars(const int& number);
GOptimizerPars(const GOptimizerPars& pars);
virtual ~GOptimizerPars(void);
// Operators
GOptimizerPars& operator=(const GOptimizerPars& pars);
GOptimizerPar* operator[](const int& index);
const GOptimizerPar* operator[](const int& index) const;
GOptimizerPar* operator[](const std::string& name);
const GOptimizerPar* operator[](const std::string& name) const;
// Methods
void clear(void);
GOptimizerPars* clone(void) const;
std::string classname(void) const;
GOptimizerPar* at(const int& index);
const GOptimizerPar* at(const int& index) const;
int size(void) const;
bool is_empty(void) const;
int nfree(void) const;
GOptimizerPar* set(const int& index, const GOptimizerPar& par);
GOptimizerPar* set(const std::string& name, const GOptimizerPar& par);
void attach(GOptimizerPar* par);
void attach(const int& index, GOptimizerPar* par);
void attach(const std::string& name, GOptimizerPar* par);
GOptimizerPar* insert(const int& index, const GOptimizerPar& par);
GOptimizerPar* insert(const std::string& name, const GOptimizerPar& par);
void remove(const int& index);
void remove(const std::string& name);
void reserve(const int& num);
void extend(const GOptimizerPars& pars);
bool contains(const std::string& name) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GOptimizerPars& pars);
void free_members(void);
int get_index(const std::string& name) const;
// Proteced members
std::vector<GOptimizerPar*> m_pars; //!< List of parameters
std::vector<bool> m_alloc; //!< Flags allocation
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GOptimizerPars").
***************************************************************************/
inline
std::string GOptimizerPars::classname(void) const
{
return ("GOptimizerPars");
}
/***********************************************************************//**
* @brief Return pointer to parameter
*
* @param[in] index Parameter index [0,...,size()-1].
* @return Pointer to parameter.
*
* Returns a pointer to the parameter with the specified @p index.
***************************************************************************/
inline
GOptimizerPar* GOptimizerPars::operator[](const int& index)
{
return (m_pars[index]);
}
/***********************************************************************//**
* @brief Return pointer to parameter (const version)
*
* @param[in] index Parameter index [0,...,size()-1].
* @return Pointer to parameter.
*
* Returns a pointer to the parameter with the specified @p index.
***************************************************************************/
inline
const GOptimizerPar* GOptimizerPars::operator[](const int& index) const
{
return (m_pars[index]);
}
/***********************************************************************//**
* @brief Return number of parameters in container
*
* @return Number of parameters in container.
*
* Returns the number of parameters in the parameter container.
***************************************************************************/
inline
int GOptimizerPars::size(void) const
{
return (int)m_pars.size();
}
/***********************************************************************//**
* @brief Signals if there are no parameters in container
*
* @return True if container is empty, false otherwise.
*
* Signals if the parameters container does not contain any parameter.
***************************************************************************/
inline
bool GOptimizerPars::is_empty(void) const
{
return (m_pars.empty());
}
/***********************************************************************//**
* @brief Reserves space for parameters in container
*
* @param[in] num Number of parameters.
*
* Reserves space for @p num parameters in the container.
***************************************************************************/
inline
void GOptimizerPars::reserve(const int& num)
{
m_pars.reserve(num);
return;
}
#endif /* GOPTIMIZERPARS_HPP */