mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
Loading...
Searching...
No Matches
templateLevmar.hpp
Go to the documentation of this file.
1/** \file templateLevmar.hpp
2 * \author Jared R. Males (jaredmales@gmail.com)
3 * \brief Templatized wrappers to the levmar minimization routines..
4 * \ingroup fitting_files
5 *
6 */
7
8//***********************************************************************//
9// Copyright 2015, 2016, 2017 Jared R. Males (jaredmales@gmail.com)
10//
11// This file is part of mxlib.
12//
13// mxlib is free software: you can redistribute it and/or modify
14// it under the terms of the GNU General Public License as published by
15// the Free Software Foundation, either version 3 of the License, or
16// (at your option) any later version.
17//
18// mxlib is distributed in the hope that it will be useful,
19// but WITHOUT ANY WARRANTY; without even the implied warranty of
20// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21// GNU General Public License for more details.
22//
23// You should have received a copy of the GNU General Public License
24// along with mxlib. If not, see <http://www.gnu.org/licenses/>.
25//***********************************************************************//
26
27#ifndef __templateLevmar_hpp__
28#define __templateLevmar_hpp__
29
30//*************************************************************************************************//
31// copied from lm.h:
32
33/* work arrays size for ?levmar_der and ?levmar_dif functions.
34 * should be multiplied by sizeof(double) or sizeof(float) to be converted to bytes
35 */
36#define LM_DER_WORKSZ( npar, nmeas ) ( 2 * ( nmeas ) + 4 * ( npar ) + ( nmeas ) * ( npar ) + ( npar ) * ( npar ) )
37#define LM_DIF_WORKSZ( npar, nmeas ) ( 4 * ( nmeas ) + 4 * ( npar ) + ( nmeas ) * ( npar ) + ( npar ) * ( npar ) )
38
39/* work arrays size for ?levmar_bc_der and ?levmar_bc_dif functions.
40 * should be multiplied by sizeof(double) or sizeof(float) to be converted to bytes
41 */
42#define LM_BC_DER_WORKSZ( npar, nmeas ) ( 2 * ( nmeas ) + 4 * ( npar ) + ( nmeas ) * ( npar ) + ( npar ) * ( npar ) )
43#define LM_BC_DIF_WORKSZ( npar, nmeas ) \
44 LM_BC_DER_WORKSZ( ( npar ), ( nmeas ) ) /* LEVMAR_BC_DIF currently implemented using LEVMAR_BC_DER()! */
45
46/* work arrays size for ?levmar_lec_der and ?levmar_lec_dif functions.
47 * should be multiplied by sizeof(double) or sizeof(float) to be converted to bytes
48 */
49#define LM_LEC_DER_WORKSZ( npar, nmeas, nconstr ) LM_DER_WORKSZ( ( npar ) - ( nconstr ), ( nmeas ) )
50#define LM_LEC_DIF_WORKSZ( npar, nmeas, nconstr ) LM_DIF_WORKSZ( ( npar ) - ( nconstr ), ( nmeas ) )
51
52/* work arrays size for ?levmar_blec_der and ?levmar_blec_dif functions.
53 * should be multiplied by sizeof(double) or sizeof(float) to be converted to bytes
54 */
55#define LM_BLEC_DER_WORKSZ( npar, nmeas, nconstr ) LM_LEC_DER_WORKSZ( ( npar ), ( nmeas ) + ( npar ), ( nconstr ) )
56#define LM_BLEC_DIF_WORKSZ( npar, nmeas, nconstr ) LM_LEC_DIF_WORKSZ( ( npar ), ( nmeas ) + ( npar ), ( nconstr ) )
57
58/* work arrays size for ?levmar_bleic_der and ?levmar_bleic_dif functions.
59 * should be multiplied by sizeof(double) or sizeof(float) to be converted to bytes
60 */
61#define LM_BLEIC_DER_WORKSZ( npar, nmeas, nconstr1, nconstr2 ) \
62 LM_BLEC_DER_WORKSZ( ( npar ) + ( nconstr2 ), ( nmeas ) + ( nconstr2 ), ( nconstr1 ) + ( nconstr2 ) )
63#define LM_BLEIC_DIF_WORKSZ( npar, nmeas, nconstr1, nconstr2 ) \
64 LM_BLEC_DIF_WORKSZ( ( npar ) + ( nconstr2 ), ( nmeas ) + ( nconstr2 ), ( nconstr1 ) + ( nconstr2 ) )
65
66#define LM_OPTS_SZ 5 /* max(4, 5) */
67#define LM_INFO_SZ 10
68#define LM_ERROR -1
69#define LM_INIT_MU 1E-03
70#define LM_STOP_THRESH 1E-17
71#define LM_DIFF_DELTA 1E-06
72#define LM_VERSION "2.6 (November 2011)"
73
74namespace mx
75{
76namespace math
77{
78namespace fit
79{
80
81template <typename floatT>
82int levmar_dif( void ( *func )( floatT *p, floatT *hx, int m, int n, void *adata ),
83 floatT *p,
84 floatT *x,
85 int m,
86 int n,
87 int itmax,
88 floatT *opts,
89 floatT *info,
90 floatT *work,
91 floatT *covar,
92 void *adata );
93
94template <>
95int levmar_dif<double>( void ( *func )( double *p, double *hx, int m, int n, void *adata ),
96 double *p,
97 double *x,
98 int m,
99 int n,
100 int itmax,
101 double *opts,
102 double *info,
103 double *work,
104 double *covar,
105 void *adata );
106
107template <>
108int levmar_dif<float>( void ( *func )( float *p, float *hx, int m, int n, void *adata ),
109 float *p,
110 float *x,
111 int m,
112 int n,
113 int itmax,
114 float *opts,
115 float *info,
116 float *work,
117 float *covar,
118 void *adata );
119
120template <typename floatT>
121int levmar_der( void ( *func )( floatT *p, floatT *hx, int m, int n, void *adata ),
122 void ( *jacf )( floatT *p, floatT *j, int m, int n, void *adata ),
123 floatT *p,
124 floatT *x,
125 int m,
126 int n,
127 int itmax,
128 floatT *opts,
129 floatT *info,
130 floatT *work,
131 floatT *covar,
132 void *adata );
133
134template <>
135int levmar_der<double>( void ( *func )( double *p, double *hx, int m, int n, void *adata ),
136 void ( *jacf )( double *p, double *j, int m, int n, void *adata ),
137 double *p,
138 double *x,
139 int m,
140 int n,
141 int itmax,
142 double *opts,
143 double *info,
144 double *work,
145 double *covar,
146 void *adata );
147
148template <>
149int levmar_der<float>( void ( *func )( float *p, float *hx, int m, int n, void *adata ),
150 void ( *jacf )( float *p, float *j, int m, int n, void *adata ),
151 float *p,
152 float *x,
153 int m,
154 int n,
155 int itmax,
156 float *opts,
157 float *info,
158 float *work,
159 float *covar,
160 void *adata );
161
162} // namespace fit
163} // namespace math
164} // namespace mx
165
166#endif // __templateLevmar_hpp__
mx::math::six_fifths
constexpr floatT six_fifths()
Return 6/5 in the specified precision.
Definition constants.hpp:404
mx
The mxlib c++ namespace.
Definition mxError.hpp:106