File: namespaceOpenMS_1_1OptimizationFunctions.html

package info (click to toggle)
openms 1.11.1-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 436,688 kB
  • ctags: 150,907
  • sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (258 lines) | stat: -rw-r--r-- 13,874 bytes parent folder | download 
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
 
<HTML>
<HEAD>
<TITLE>OpenMS::OptimizationFunctions Namespace Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="namespaceOpenMS_1_1OptimizationFunctions.html">OptimizationFunctions</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">OpenMS::OptimizationFunctions Namespace Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Namespace for all functions and classes needed for the gsl levenberg-marquard algorithm.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1OptimizationFunctions_1_1PenaltyFactorsIntensity.html">PenaltyFactorsIntensity</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class for the penalty factors used during the optimization.  <a href="structOpenMS_1_1OptimizationFunctions_1_1PenaltyFactorsIntensity.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1OptimizationFunctions_1_1PenaltyFactors.html">PenaltyFactors</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class for the penalty factors used during the optimization.  <a href="structOpenMS_1_1OptimizationFunctions_1_1PenaltyFactors.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a1b5cab7fcfe8ad040fb7363dd14913f1"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="classOpenMS_1_1Peak1D.html">Peak1D</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS_1_1OptimizationFunctions.html#a1b5cab7fcfe8ad040fb7363dd14913f1">RawDataVector</a></td></tr>
<tr class="memdesc:a1b5cab7fcfe8ad040fb7363dd14913f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raw data vector type.  <a href="#a1b5cab7fcfe8ad040fb7363dd14913f1">More...</a><br/></td></tr>
<tr class="separator:a1b5cab7fcfe8ad040fb7363dd14913f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a335cff277df421bfa0ce8d2412f02134"><td class="memItemLeft" align="right" valign="top">typedef RawDataVector::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS_1_1OptimizationFunctions.html#a335cff277df421bfa0ce8d2412f02134">PeakIterator</a></td></tr>
<tr class="memdesc:a335cff277df421bfa0ce8d2412f02134"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raw data iterator type.  <a href="#a335cff277df421bfa0ce8d2412f02134">More...</a><br/></td></tr>
<tr class="separator:a335cff277df421bfa0ce8d2412f02134"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3d21e47729faa48b51b02169c9383902"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS_1_1OptimizationFunctions.html#a3d21e47729faa48b51b02169c9383902">residual</a> (const gsl_vector *x, void *params, gsl_vector *f)</td></tr>
<tr class="memdesc:a3d21e47729faa48b51b02169c9383902"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluation of the target function for nonlinear optimization.  <a href="#a3d21e47729faa48b51b02169c9383902">More...</a><br/></td></tr>
<tr class="separator:a3d21e47729faa48b51b02169c9383902"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a906050fe19898e6bdaad3442b61c7199"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS_1_1OptimizationFunctions.html#a906050fe19898e6bdaad3442b61c7199">jacobian</a> (const gsl_vector *x, void *params, gsl_matrix *J)</td></tr>
<tr class="memdesc:a906050fe19898e6bdaad3442b61c7199"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the Jacobian of the residual, where each row of the matrix corresponds to a point in the data.  <a href="#a906050fe19898e6bdaad3442b61c7199">More...</a><br/></td></tr>
<tr class="separator:a906050fe19898e6bdaad3442b61c7199"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacf12ce6c8657d87174c792d19c318bf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS_1_1OptimizationFunctions.html#aacf12ce6c8657d87174c792d19c318bf">evaluate</a> (const gsl_vector *x, void *params, gsl_vector *f, gsl_matrix *J)</td></tr>
<tr class="memdesc:aacf12ce6c8657d87174c792d19c318bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Driver function for the evaluation of function and jacobian.  <a href="#aacf12ce6c8657d87174c792d19c318bf">More...</a><br/></td></tr>
<tr class="separator:aacf12ce6c8657d87174c792d19c318bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1221d2aacdd4ec15f8604ec526e500a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS_1_1OptimizationFunctions.html#a1221d2aacdd4ec15f8604ec526e500a4">printSignal</a> (const gsl_vector *x, void *param, float resolution=0.25)</td></tr>
<tr class="memdesc:a1221d2aacdd4ec15f8604ec526e500a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print all peak shapes.  <a href="#a1221d2aacdd4ec15f8604ec526e500a4">More...</a><br/></td></tr>
<tr class="separator:a1221d2aacdd4ec15f8604ec526e500a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Namespace for all functions and classes needed for the gsl levenberg-marquard algorithm. </p>
<p>We have to use function pointers for the gsl and can't put them into a class, so we provide an extra namespace. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a335cff277df421bfa0ce8d2412f02134"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef RawDataVector::iterator <a class="el" href="namespaceOpenMS_1_1OptimizationFunctions.html#a335cff277df421bfa0ce8d2412f02134">PeakIterator</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Raw data iterator type. </p>

</div>
</div>
<a class="anchor" id="a1b5cab7fcfe8ad040fb7363dd14913f1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::vector&lt;<a class="el" href="classOpenMS_1_1Peak1D.html">Peak1D</a>&gt; <a class="el" href="namespaceOpenMS_1_1OptimizationFunctions.html#a1b5cab7fcfe8ad040fb7363dd14913f1">RawDataVector</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Raw data vector type. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aacf12ce6c8657d87174c792d19c318bf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int OpenMS::OptimizationFunctions::evaluate </td>
          <td>(</td>
          <td class="paramtype">const gsl_vector *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>params</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gsl_vector *&#160;</td>
          <td class="paramname"><em>f</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gsl_matrix *&#160;</td>
          <td class="paramname"><em>J</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Driver function for the evaluation of function and jacobian. </p>

<p>Referenced by <a class="el" href="classOpenMS_1_1LevMarqFitter1D.html#a6cf7a822ee5c9db565d40e235646ee78">LevMarqFitter1D::optimize_()</a>, and <a class="el" href="classOpenMS_1_1TraceFitter.html#a69d24e3ee5021aebcec9f61015fb5313">TraceFitter&lt; PeakType &gt;::optimize_()</a>.</p>

</div>
</div>
<a class="anchor" id="a906050fe19898e6bdaad3442b61c7199"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int OpenMS::OptimizationFunctions::jacobian </td>
          <td>(</td>
          <td class="paramtype">const gsl_vector *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>params</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gsl_matrix *&#160;</td>
          <td class="paramname"><em>J</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Compute the Jacobian of the residual, where each row of the matrix corresponds to a point in the data. </p>

<p>Referenced by <a class="el" href="classOpenMS_1_1LevMarqFitter1D.html#a6cf7a822ee5c9db565d40e235646ee78">LevMarqFitter1D::optimize_()</a>, and <a class="el" href="classOpenMS_1_1TraceFitter.html#a69d24e3ee5021aebcec9f61015fb5313">TraceFitter&lt; PeakType &gt;::optimize_()</a>.</p>

</div>
</div>
<a class="anchor" id="a1221d2aacdd4ec15f8604ec526e500a4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OpenMS::OptimizationFunctions::printSignal </td>
          <td>(</td>
          <td class="paramtype">const gsl_vector *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>param</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>resolution</em> = <code>0.25</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Print all peak shapes. </p>

</div>
</div>
<a class="anchor" id="a3d21e47729faa48b51b02169c9383902"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int OpenMS::OptimizationFunctions::residual </td>
          <td>(</td>
          <td class="paramtype">const gsl_vector *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>params</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gsl_vector *&#160;</td>
          <td class="paramname"><em>f</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Evaluation of the target function for nonlinear optimization. </p>

<p>Referenced by <a class="el" href="classOpenMS_1_1LevMarqFitter1D.html#a6cf7a822ee5c9db565d40e235646ee78">LevMarqFitter1D::optimize_()</a>, and <a class="el" href="classOpenMS_1_1TraceFitter.html#a69d24e3ee5021aebcec9f61015fb5313">TraceFitter&lt; PeakType &gt;::optimize_()</a>.</p>

</div>
</div>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:38 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>