GOptimizerLM.hpp
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
412
/***************************************************************************
* GOptimizerLM.hpp - Levenberg Marquardt optimizer *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2017 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 GOptimizerLM.hpp
* @brief Levenberg Marquardt optimizer class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GOPTIMIZERLM_HPP
#define GOPTIMIZERLM_HPP
/* __ Includes ___________________________________________________________ */
#include <vector>
#include "GOptimizer.hpp"
#include "GOptimizerFunction.hpp"
#include "GLog.hpp"
/* __ Definitions ________________________________________________________ */
#define G_LM_CONVERGED 0
#define G_LM_STALLED 1
#define G_LM_SINGULAR 2
#define G_LM_NOT_POSTIVE_DEFINITE 3
#define G_LM_BAD_ERRORS 4
/***********************************************************************//**
* @class GOptimizerLM
*
* @brief Levenberg Marquardt optimizer class
*
* This method implements an Levenberg Marquardt optimizer.
***************************************************************************/
class GOptimizerLM : public GOptimizer {
public:
// Constructors and destructors
GOptimizerLM(void);
explicit GOptimizerLM(GLog* log);
GOptimizerLM(const GOptimizerLM& opt);
virtual ~GOptimizerLM(void);
// Operators
GOptimizerLM& operator=(const GOptimizerLM& opt);
// Implemented pure virtual base class methods
virtual void clear(void);
virtual GOptimizerLM* clone(void) const;
virtual std::string classname(void) const;
virtual void optimize(GOptimizerFunction& fct, GOptimizerPars& pars);
virtual void errors(GOptimizerFunction& fct, GOptimizerPars& pars);
virtual double value(void) const;
virtual int status(void) const;
virtual int iter(void) const;
virtual std::string print(const GChatter& chatter = NORMAL) const;
// Methods
void logger(GLog* log);
void max_iter(const int& max_iter);
void max_stalls(const int& max_stalls);
void max_boundary_hits(const int& max_hit);
void lambda_start(const double& value);
void lambda_inc(const double& value);
void lambda_dec(const double& value);
void eps(const double& eps);
void accept_dec(const double& value);
int max_iter(void) const;
int max_stalls(void) const;
int max_boundary_hits(void) const;
const double& lambda_start(void) const;
const double& lambda_inc(void) const;
const double& lambda_dec(void) const;
const double& lambda(void) const;
const double& eps(void) const;
const double& accept_dec(void) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GOptimizerLM& opt);
void free_members(void);
double iteration(GOptimizerFunction& fct, GOptimizerPars& pars);
double step_size(const GVector& grad, const GOptimizerPars& pars);
// Protected members
int m_npars; //!< Number of parameters
int m_nfree; //!< Number of free parameters
double m_lambda_start; //!< Initial start value
double m_lambda_inc; //!< Lambda increase
double m_lambda_dec; //!< Lambda decrease
double m_eps; //!< Absolute precision
double m_accept_dec; //!< Acceptable function decrease
int m_max_iter; //!< Maximum number of iterations
int m_max_stall; //!< Maximum number of stalls
int m_max_hit; //!< Maximum number of successive hits
int m_max_dec; //!< Maximum number of function decrease
bool m_step_adjust; //!< Adjust step size to boundaries
std::vector<bool> m_hit_boundary; //!< Bookkeeping array for boundary hits
std::vector<int> m_hit_minimum; //!< Bookkeeping of successive minimum hits
std::vector<int> m_hit_maximum; //!< Bookkeeping of successive maximum hits
std::vector<bool> m_par_freeze; //!< Bookkeeping of parameter freeze
std::vector<bool> m_par_remove; //!< Bookkeeping of parameter removal
double m_lambda; //!< Actual lambda
double m_value; //!< Actual function value
double m_delta; //!< Function improvement
int m_status; //!< Fit status
int m_iter; //!< Iteration
int m_num_dec; //!< Number of function decreases
GLog* m_logger; //!< Pointer to optional logger
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GOptimizerLM").
***************************************************************************/
inline
std::string GOptimizerLM::classname(void) const
{
return ("GOptimizerLM");
}
/***********************************************************************//**
* @brief Return function value
*
* @return Function value.
***************************************************************************/
inline
double GOptimizerLM::value(void) const
{
return (m_value);
}
/***********************************************************************//**
* @brief Return optimizer status
*
* @return Optimizer status.
***************************************************************************/
inline
int GOptimizerLM::status(void) const
{
return (m_status);
}
/***********************************************************************//**
* @brief Return number of iterations
*
* @return Number of iterations.
***************************************************************************/
inline
int GOptimizerLM::iter(void) const
{
return (m_iter);
}
/***********************************************************************//**
* @brief Set logger
*
* @param[in] log Logger to use in optimizer.
*
* Set the logger into which the optimizer will dump any output.
***************************************************************************/
inline
void GOptimizerLM::logger(GLog* log)
{
m_logger = log;
return;
}
/***********************************************************************//**
* @brief Set maximum number of iterations
*
* @param[in] max_iter Maximum number of iterations.
***************************************************************************/
inline
void GOptimizerLM::max_iter(const int& max_iter)
{
m_max_iter = max_iter;
return;
}
/***********************************************************************//**
* @brief Set maximum number of allowed subsequent stalls
*
* @param[in] max_stalls Maximum number of allowed subsequent stalls.
***************************************************************************/
inline
void GOptimizerLM::max_stalls(const int& max_stalls)
{
m_max_stall = max_stalls;
return;
}
/***********************************************************************//**
* @brief Set maximum number of parameter boundary hits
*
* @param[in] max_hit Maximum number of parameter boundary hits.
***************************************************************************/
inline
void GOptimizerLM::max_boundary_hits(const int& max_hit)
{
m_max_hit = max_hit;
return;
}
/***********************************************************************//**
* @brief Set lambda starting value
*
* @param[in] value Lambda starting value.
***************************************************************************/
inline
void GOptimizerLM::lambda_start(const double& value)
{
m_lambda_start = value;
return;
}
/***********************************************************************//**
* @brief Set lambda increment value
*
* @param[in] value Lambda increment value.
***************************************************************************/
inline
void GOptimizerLM::lambda_inc(const double& value)
{
m_lambda_inc = value;
return;
}
/***********************************************************************//**
* @brief Set lambda decrement value
*
* @param[in] value Lambda decrement value.
***************************************************************************/
inline
void GOptimizerLM::lambda_dec(const double& value)
{
m_lambda_dec = value;
return;
}
/***********************************************************************//**
* @brief Set requested absolute convergence precision
*
* @param[in] eps Requested absolute convergence precision.
***************************************************************************/
inline
void GOptimizerLM::eps(const double& eps)
{
m_eps = eps;
return;
}
/***********************************************************************//**
* @brief Set acceptable function decrease
*
* @param[in] value Acceptable function decrease.
*
* Sets the acceptable function decrease value for which the new solution
* will be kept and the iterations continue. This strategy provides better
* convergence in case that a function decrease is encountered.
***************************************************************************/
inline
void GOptimizerLM::accept_dec(const double& value)
{
m_accept_dec = value;
return;
}
/***********************************************************************//**
* @brief Return maximum number of iterations
*
* @return Maximum number of iterations.
***************************************************************************/
inline
int GOptimizerLM::max_iter(void) const
{
return (m_max_iter);
}
/***********************************************************************//**
* @brief Return maximum number of allowed subsequent stalls
*
* @return Maximum number of allowed subsequent stalls.
***************************************************************************/
inline
int GOptimizerLM::max_stalls(void) const
{
return (m_max_stall);
}
/***********************************************************************//**
* @brief Return maximum number of parameter boundary hits
*
* @return Maximum number of parameter boundary hits.
***************************************************************************/
inline
int GOptimizerLM::max_boundary_hits(void) const
{
return (m_max_hit);
}
/***********************************************************************//**
* @brief Return lambda starting value
*
* @return Lambda starting value.
***************************************************************************/
inline
const double& GOptimizerLM::lambda_start(void) const
{
return (m_lambda_start);
}
/***********************************************************************//**
* @brief Return lambda increment value
*
* @return Lambda increment value.
***************************************************************************/
inline
const double& GOptimizerLM::lambda_inc(void) const
{
return (m_lambda_inc);
}
/***********************************************************************//**
* @brief Return lambda decrement value
*
* @return Lambda decrement value.
***************************************************************************/
inline
const double& GOptimizerLM::lambda_dec(void) const
{
return (m_lambda_dec);
}
/***********************************************************************//**
* @brief Return lambda value
*
* @return Lambda value.
***************************************************************************/
inline
const double& GOptimizerLM::lambda(void) const
{
return (m_lambda);
}
/***********************************************************************//**
* @brief Return requested absolute convergence precision
*
* @return Requested absolute convergence precision.
***************************************************************************/
inline
const double& GOptimizerLM::eps(void) const
{
return (m_eps);
}
/***********************************************************************//**
* @brief Return acceptable function decrease
*
* @return Acceptable function decrease.
***************************************************************************/
inline
const double& GOptimizerLM::accept_dec(void) const
{
return (m_accept_dec);
}
#endif /* GOPTIMIZERLM_HPP */