/usr/share/doc/mia-2.0/libdoc/classCMinimizer.html is in libmia-2.0-doc 2.0.13-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>CMinimizer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">CMinimizer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__basic.html">Basic data strctures and functions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A class for generalized minimization problems.
<a href="classCMinimizer.html#details">More...</a></p>
<p><code>#include <<a class="el" href="minimizer_8hh_source.html">mia/core/minimizer.hh</a>></code></p>
<div class="dynheader">
Inheritance diagram for CMinimizer:</div>
<div class="dyncontent">
<div class="center">
<img src="classCMinimizer.png" usemap="#CMinimizer_map" alt=""/>
<map id="CMinimizer_map" name="CMinimizer_map">
<area href="classCProductBase.html" title="The base class for all plug-in created object. " alt="CProductBase" shape="rect" coords="0,56,133,80"/>
<area href="classCPropertyFlagHolder.html" title="This class holds a set of properties. " alt="CPropertyFlagHolder" shape="rect" coords="0,0,133,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer_1_1Problem.html">Problem</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for all optimization problems that can be run by <a class="el" href="classCMinimizer.html" title="A class for generalized minimization problems. ">CMinimizer</a>. <a href="classCMinimizer_1_1Problem.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9fad4cd49222c5cd2ca1b86c33911afe"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#a9fad4cd49222c5cd2ca1b86c33911afe">EMinimizerResult</a> { <a class="el" href="classCMinimizer.html#a9fad4cd49222c5cd2ca1b86c33911afea23aa185b88929f984d5154483621dfc4">failure</a>,
<a class="el" href="classCMinimizer.html#a9fad4cd49222c5cd2ca1b86c33911afea5e0ae5d9db4f782b7630de09b9f33081">success</a>
}</td></tr>
<tr class="memdesc:a9fad4cd49222c5cd2ca1b86c33911afe"><td class="mdescLeft"> </td><td class="mdescRight">enum to describe whether optimization succeeded <a href="classCMinimizer.html#a9fad4cd49222c5cd2ca1b86c33911afe">More...</a><br/></td></tr>
<tr class="separator:a9fad4cd49222c5cd2ca1b86c33911afe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a874af6759ea3673492f56ae39619f584"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classCMinimizer.html">CMinimizer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#a874af6759ea3673492f56ae39619f584">plugin_data</a></td></tr>
<tr class="memdesc:a874af6759ea3673492f56ae39619f584"><td class="mdescLeft"> </td><td class="mdescRight">plug-in searchpath typedef helper <a href="#a874af6759ea3673492f56ae39619f584">More...</a><br/></td></tr>
<tr class="separator:a874af6759ea3673492f56ae39619f584"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a606bb800be45d95bf576e76e28ef81"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classCMinimizer.html">CMinimizer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#a4a606bb800be45d95bf576e76e28ef81">plugin_type</a></td></tr>
<tr class="memdesc:a4a606bb800be45d95bf576e76e28ef81"><td class="mdescLeft"> </td><td class="mdescRight">plug-in searchpath typedef helper <a href="#a4a606bb800be45d95bf576e76e28ef81">More...</a><br/></td></tr>
<tr class="separator:a4a606bb800be45d95bf576e76e28ef81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5204b1ae95c0fcf0c108d5d2621ed44"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr<br class="typebreak"/>
< <a class="el" href="classCMinimizer.html">CMinimizer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#ac5204b1ae95c0fcf0c108d5d2621ed44">Pointer</a></td></tr>
<tr class="memdesc:ac5204b1ae95c0fcf0c108d5d2621ed44"><td class="mdescLeft"> </td><td class="mdescRight">Pointer type of this minimizer. <a href="#ac5204b1ae95c0fcf0c108d5d2621ed44">More...</a><br/></td></tr>
<tr class="separator:ac5204b1ae95c0fcf0c108d5d2621ed44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d75f819c1b23f1bcde9461431945f20"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="classCMinimizer_1_1Problem.html">Problem</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#a1d75f819c1b23f1bcde9461431945f20">PProblem</a></td></tr>
<tr class="memdesc:a1d75f819c1b23f1bcde9461431945f20"><td class="mdescLeft"> </td><td class="mdescRight">pointer type for the optimization problem <a href="#a1d75f819c1b23f1bcde9461431945f20">More...</a><br/></td></tr>
<tr class="separator:a1d75f819c1b23f1bcde9461431945f20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_types_classCPropertyFlagHolder"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classCPropertyFlagHolder')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classCPropertyFlagHolder.html">CPropertyFlagHolder</a></td></tr>
<tr class="memitem:ae19cdabd533c31d596b479686943e13e inherit pub_types_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top">typedef std::set< const char * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#ae19cdabd533c31d596b479686943e13e">Set</a></td></tr>
<tr class="memdesc:ae19cdabd533c31d596b479686943e13e inherit pub_types_classCPropertyFlagHolder"><td class="mdescLeft"> </td><td class="mdescRight">define the type of the set of flags <a href="#ae19cdabd533c31d596b479686943e13e">More...</a><br/></td></tr>
<tr class="separator:ae19cdabd533c31d596b479686943e13e inherit pub_types_classCPropertyFlagHolder"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acf177ea109ceb260a343ba9c6b23ee64"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#acf177ea109ceb260a343ba9c6b23ee64">CMinimizer</a> ()</td></tr>
<tr class="separator:acf177ea109ceb260a343ba9c6b23ee64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef40af0691f7c562342dded54af871c0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#aef40af0691f7c562342dded54af871c0">run</a> (<a class="el" href="group__misc.html#ga763570a5d6b0bf1ff4af8e359d03d938">CDoubleVector</a> &x)</td></tr>
<tr class="separator:aef40af0691f7c562342dded54af871c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abac760dddfd366290f11e7625ac127fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#abac760dddfd366290f11e7625ac127fc">set_problem</a> (<a class="el" href="classCMinimizer.html#a1d75f819c1b23f1bcde9461431945f20">PProblem</a> x)</td></tr>
<tr class="separator:abac760dddfd366290f11e7625ac127fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee78fe8052ffdba58231636b34a5aa0a"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#aee78fe8052ffdba58231636b34a5aa0a">~CMinimizer</a> ()</td></tr>
<tr class="separator:aee78fe8052ffdba58231636b34a5aa0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classCProductBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCProductBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classCProductBase.html">CProductBase</a></td></tr>
<tr class="memitem:acfa85a057a881ced532bb78029efddc4 inherit pub_methods_classCProductBase"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCProductBase.html#acfa85a057a881ced532bb78029efddc4">get_init_string</a> () const </td></tr>
<tr class="separator:acfa85a057a881ced532bb78029efddc4 inherit pub_methods_classCProductBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60ef92211cb697cc9d3bde947d668e9e inherit pub_methods_classCProductBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCProductBase.html#a60ef92211cb697cc9d3bde947d668e9e">set_init_string</a> (const char *init)</td></tr>
<tr class="separator:a60ef92211cb697cc9d3bde947d668e9e inherit pub_methods_classCProductBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac78b75f25de93e9a8c9d9c6ee34b5fa2 inherit pub_methods_classCProductBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCProductBase.html#ac78b75f25de93e9a8c9d9c6ee34b5fa2">set_module</a> (<a class="el" href="group__plugin.html#ga39fb45d0925ecaf649ca861cab0ee01a">PPluginModule</a> module)</td></tr>
<tr class="separator:ac78b75f25de93e9a8c9d9c6ee34b5fa2 inherit pub_methods_classCProductBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classCPropertyFlagHolder"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCPropertyFlagHolder')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classCPropertyFlagHolder.html">CPropertyFlagHolder</a></td></tr>
<tr class="memitem:a365d4cdb13500e1a4139e837fe7cb37c inherit pub_methods_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#a365d4cdb13500e1a4139e837fe7cb37c">add</a> (const char *property)</td></tr>
<tr class="separator:a365d4cdb13500e1a4139e837fe7cb37c inherit pub_methods_classCPropertyFlagHolder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8410fdf2a8b736c700d8595d82acb1fc inherit pub_methods_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCPropertyFlagHolder.html#ae19cdabd533c31d596b479686943e13e">Set</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#a8410fdf2a8b736c700d8595d82acb1fc">get_missing_properties</a> (const <a class="el" href="classCPropertyFlagHolder.html">CPropertyFlagHolder</a> &testset) const </td></tr>
<tr class="separator:a8410fdf2a8b736c700d8595d82acb1fc inherit pub_methods_classCPropertyFlagHolder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a106e9895cd3a2f5d7a121b6a41b0eebd inherit pub_methods_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#a106e9895cd3a2f5d7a121b6a41b0eebd">has</a> (const char *property) const </td></tr>
<tr class="separator:a106e9895cd3a2f5d7a121b6a41b0eebd inherit pub_methods_classCPropertyFlagHolder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a110f2cdcf0cd275830b92deed7a0d648 inherit pub_methods_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#a110f2cdcf0cd275830b92deed7a0d648">has_all_in</a> (const <a class="el" href="classCPropertyFlagHolder.html">CPropertyFlagHolder</a> &testset) const </td></tr>
<tr class="separator:a110f2cdcf0cd275830b92deed7a0d648 inherit pub_methods_classCPropertyFlagHolder"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7612f039bf567bd94e79dc045de39e1 inherit pub_methods_classCPropertyFlagHolder"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPropertyFlagHolder.html#ae7612f039bf567bd94e79dc045de39e1">~CPropertyFlagHolder</a> ()</td></tr>
<tr class="separator:ae7612f039bf567bd94e79dc045de39e1 inherit pub_methods_classCPropertyFlagHolder"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a6c45fd3c49cb9354c9e5715b2203b8c5"><td class="memItemLeft" align="right" valign="top">static const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#a6c45fd3c49cb9354c9e5715b2203b8c5">data_descr</a></td></tr>
<tr class="memdesc:a6c45fd3c49cb9354c9e5715b2203b8c5"><td class="mdescLeft"> </td><td class="mdescRight">plug-in searchpath helper <a href="#a6c45fd3c49cb9354c9e5715b2203b8c5">More...</a><br/></td></tr>
<tr class="separator:a6c45fd3c49cb9354c9e5715b2203b8c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a3a394ddd6c8cff608e3fc5cbb97e20"><td class="memItemLeft" align="right" valign="top">static const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#a9a3a394ddd6c8cff608e3fc5cbb97e20">type_descr</a></td></tr>
<tr class="memdesc:a9a3a394ddd6c8cff608e3fc5cbb97e20"><td class="mdescLeft"> </td><td class="mdescRight">plug-in searchpath helper <a href="#a9a3a394ddd6c8cff608e3fc5cbb97e20">More...</a><br/></td></tr>
<tr class="separator:a9a3a394ddd6c8cff608e3fc5cbb97e20"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af6c34a383272153439fd0b3add47fef2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCMinimizer_1_1Problem.html">Problem</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#af6c34a383272153439fd0b3add47fef2">get_problem</a> ()</td></tr>
<tr class="separator:af6c34a383272153439fd0b3add47fef2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afde8085d795a6dbc584255f06206911d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCMinimizer_1_1Problem.html">Problem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#afde8085d795a6dbc584255f06206911d">get_problem_pointer</a> ()</td></tr>
<tr class="separator:afde8085d795a6dbc584255f06206911d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4df7cb834c38c8a8073e1a59a846c3d1"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCMinimizer.html#a4df7cb834c38c8a8073e1a59a846c3d1">size</a> () const </td></tr>
<tr class="separator:a4df7cb834c38c8a8073e1a59a846c3d1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class for generalized minimization problems. </p>
<p>This class defined the interface for a generalized minimizer that may use gradient information. Specific implementations are provided as plug-ins. </p>
<p>Definition at line <a class="el" href="minimizer_8hh_source.html#l00042">42</a> of file <a class="el" href="minimizer_8hh_source.html">minimizer.hh</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a874af6759ea3673492f56ae39619f584"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classCMinimizer.html">CMinimizer</a> <a class="el" href="classCMinimizer.html#a874af6759ea3673492f56ae39619f584">CMinimizer::plugin_data</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>plug-in searchpath typedef helper </p>
<p>Definition at line <a class="el" href="minimizer_8hh_source.html#l00046">46</a> of file <a class="el" href="minimizer_8hh_source.html">minimizer.hh</a>.</p>
</div>
</div>
<a class="anchor" id="a4a606bb800be45d95bf576e76e28ef81"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classCMinimizer.html">CMinimizer</a> <a class="el" href="classCMinimizer.html#a4a606bb800be45d95bf576e76e28ef81">CMinimizer::plugin_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>plug-in searchpath typedef helper </p>
<p>Definition at line <a class="el" href="minimizer_8hh_source.html#l00048">48</a> of file <a class="el" href="minimizer_8hh_source.html">minimizer.hh</a>.</p>
</div>
</div>
<a class="anchor" id="ac5204b1ae95c0fcf0c108d5d2621ed44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::shared_ptr<<a class="el" href="classCMinimizer.html">CMinimizer</a>> <a class="el" href="classCMinimizer.html#ac5204b1ae95c0fcf0c108d5d2621ed44">CMinimizer::Pointer</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer type of this minimizer. </p>
<p>Definition at line <a class="el" href="minimizer_8hh_source.html#l00051">51</a> of file <a class="el" href="minimizer_8hh_source.html">minimizer.hh</a>.</p>
</div>
</div>
<a class="anchor" id="a1d75f819c1b23f1bcde9461431945f20"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::shared_ptr<<a class="el" href="classCMinimizer_1_1Problem.html">Problem</a>> <a class="el" href="classCMinimizer.html#a1d75f819c1b23f1bcde9461431945f20">CMinimizer::PProblem</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer type for the optimization problem </p>
<p>Definition at line <a class="el" href="minimizer_8hh_source.html#l00178">178</a> of file <a class="el" href="minimizer_8hh_source.html">minimizer.hh</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a9fad4cd49222c5cd2ca1b86c33911afe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classCMinimizer.html#a9fad4cd49222c5cd2ca1b86c33911afe">CMinimizer::EMinimizerResult</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>enum to describe whether optimization succeeded </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a9fad4cd49222c5cd2ca1b86c33911afea23aa185b88929f984d5154483621dfc4"></a>failure</em> </td><td class="fielddoc">
<p>optimization failed </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9fad4cd49222c5cd2ca1b86c33911afea5e0ae5d9db4f782b7630de09b9f33081"></a>success</em> </td><td class="fielddoc">
<p>optimization succeeded </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="minimizer_8hh_source.html#l00054">54</a> of file <a class="el" href="minimizer_8hh_source.html">minimizer.hh</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="acf177ea109ceb260a343ba9c6b23ee64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CMinimizer::CMinimizer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construtor of the optimizer. </p>
</div>
</div>
<a class="anchor" id="aee78fe8052ffdba58231636b34a5aa0a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual CMinimizer::~CMinimizer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af6c34a383272153439fd0b3add47fef2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCMinimizer_1_1Problem.html">CMinimizer::Problem</a> & CMinimizer::get_problem </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a read/write reference to the current optimization problem </dd></dl>
<p>Definition at line <a class="el" href="minimizer_8hh_source.html#l00230">230</a> of file <a class="el" href="minimizer_8hh_source.html">minimizer.hh</a>.</p>
</div>
</div>
<a class="anchor" id="afde8085d795a6dbc584255f06206911d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCMinimizer_1_1Problem.html">Problem</a>* CMinimizer::get_problem_pointer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a raw pointer to the optimization problem </dd></dl>
</div>
</div>
<a class="anchor" id="aef40af0691f7c562342dded54af871c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CMinimizer::run </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__misc.html#ga763570a5d6b0bf1ff4af8e359d03d938">CDoubleVector</a> & </td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Run the optimization </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">x</td><td>at entry contains the start point of the optimization at exit the optimized value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>returns a status whether the optimization succeeded or why it stopped </dd></dl>
</div>
</div>
<a class="anchor" id="abac760dddfd366290f11e7625ac127fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMinimizer::set_problem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCMinimizer.html#a1d75f819c1b23f1bcde9461431945f20">PProblem</a> </td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the optimization problem </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>problem to be optimized </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4df7cb834c38c8a8073e1a59a846c3d1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t CMinimizer::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the size (degrees of freedom) of the optimization problem </dd></dl>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a6c45fd3c49cb9354c9e5715b2203b8c5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* const CMinimizer::data_descr</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>plug-in searchpath helper </p>
<p>Definition at line <a class="el" href="minimizer_8hh_source.html#l00062">62</a> of file <a class="el" href="minimizer_8hh_source.html">minimizer.hh</a>.</p>
</div>
</div>
<a class="anchor" id="a9a3a394ddd6c8cff608e3fc5cbb97e20"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* const CMinimizer::type_descr</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>plug-in searchpath helper </p>
<p>Definition at line <a class="el" href="minimizer_8hh_source.html#l00059">59</a> of file <a class="el" href="minimizer_8hh_source.html">minimizer.hh</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="minimizer_8hh_source.html">minimizer.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:09 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|