140 lines
17 KiB
HTML
Executable File
140 lines
17 KiB
HTML
Executable File
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Thibault Barnouin Optimization Method Algorithm: methods.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.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! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Thibault Barnouin Optimization Method Algorithm
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">methods.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="methods_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef METHODS_H</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define METHODS_H</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include"<a class="code" href="models_8h.html">models.h</a>"</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Optimization Methods</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="classOptimizationMethod.html"> 10</a></span> <span class="keyword">class </span><a class="code" href="classOptimizationMethod.html">OptimizationMethod</a>{</div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <span class="comment">//Virtual Constructor & Destructor for any optimization method</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classOptimizationMethod.html#a8490a7cd0e3334f7e61469377c7d4217"> 13</a></span>  <a class="code" href="classOptimizationMethod.html#a8490a7cd0e3334f7e61469377c7d4217">OptimizationMethod</a>(){};</div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classOptimizationMethod.html#afe937854a5a30a514dc0414342132630"> 14</a></span>  <a class="code" href="classOptimizationMethod.html#afe937854a5a30a514dc0414342132630">OptimizationMethod</a>(<a class="code" href="classModel.html">Model</a>* A):<a class="code" href="classOptimizationMethod.html#a8facd4ec032c5613003238d88a3354de">ToAdjust</a>(A){};</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="classOptimizationMethod.html#ab33ddd12499ebedbc73f125a65a21442"> 15</a></span>  <span class="keyword">virtual</span> <a class="code" href="classOptimizationMethod.html#ab33ddd12499ebedbc73f125a65a21442">~OptimizationMethod</a>(){};</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="comment">//Virtual initialisation, execution, finalisation for any optimization method</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classOptimizationMethod.html#aa91c542184436065dc1dc2cac3ada639"> 17</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOptimizationMethod.html#aa91c542184436065dc1dc2cac3ada639">initialise</a>(){}; <span class="comment">//Initialise attributes using values stored in the method header file</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classOptimizationMethod.html#adb01ff9af919dbb2c60eb02512a8c3dc"> 18</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOptimizationMethod.html#adb01ff9af919dbb2c60eb02512a8c3dc">execute</a>(){}; <span class="comment">//Execute the optimization of the model</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOptimizationMethod.html#ae74af2b7ddb2720db1bc1554d577a1a6">finalise</a>() <span class="keyword">const</span> = 0; <span class="comment">//Export the model parameters and display the optimized model</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classOptimizationMethod.html#a8facd4ec032c5613003238d88a3354de"> 21</a></span>  <a class="code" href="classModel.html">Model</a>* <a class="code" href="classOptimizationMethod.html#a8facd4ec032c5613003238d88a3354de">ToAdjust</a>;</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> };</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// Simulated Annealing</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classSimulatedAnnealing.html"> 26</a></span> <span class="keyword">class </span><a class="code" href="classSimulatedAnnealing.html">SimulatedAnnealing</a> : <span class="keyword">public</span> <a class="code" href="classOptimizationMethod.html">OptimizationMethod</a>{</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">//Constructor & Destructor specific to this method</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="classSimulatedAnnealing.html#af5a6ed64727a4594f347289527ff8b9a">SimulatedAnnealing</a>();</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="classSimulatedAnnealing.html#af5a6ed64727a4594f347289527ff8b9a">SimulatedAnnealing</a>(<a class="code" href="classModel.html">Model</a>*);</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classSimulatedAnnealing.html#af5a6ed64727a4594f347289527ff8b9a">SimulatedAnnealing</a>(<a class="code" href="classModel.html">Model</a>*,<span class="keywordtype">double</span>,<span class="keywordtype">double</span>,<span class="keywordtype">double</span>,<span class="keywordtype">double</span>,<span class="keywordtype">int</span>,<span class="keywordtype">int</span>);</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classSimulatedAnnealing.html#ab8630a5a98e257bab37f9b998329e397"> 32</a></span>  <a class="code" href="classSimulatedAnnealing.html#ab8630a5a98e257bab37f9b998329e397">~SimulatedAnnealing</a>(){};</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">//Initialisation, execution and finalisation for this method</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">void</span> <a class="code" href="classSimulatedAnnealing.html#a2bb082c85be4814998b9f54ca6f05f7f">initialise</a>();</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">void</span> <a class="code" href="classSimulatedAnnealing.html#a28b0004727cd54ad17c13c0da33168f1">execute</a>();</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">void</span> <a class="code" href="classSimulatedAnnealing.html#a6c76ea1faede9c60a8dd732b6a26efea">finalise</a>() <span class="keyword">const</span> ;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">double</span> ampl; <span class="comment">//Variation amplitude to get Neighbor</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">double</span> temp; <span class="comment">//Current temperature of the system</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">double</span> t_end; <span class="comment">//Freezing temperature</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">double</span> cooling; <span class="comment">//Cooling ratio</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">int</span> length; <span class="comment">//Number of iteration for the same value of temperature</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">int</span> max_f; <span class="comment">//Max number of unsuccessful iterations</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">int</span> current_f; <span class="comment">//Current number of unsuccessful iteration combo</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> };</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassSimulatedAnnealing_html"><div class="ttname"><a href="classSimulatedAnnealing.html">SimulatedAnnealing</a></div><div class="ttdef"><b>Definition:</b> methods.h:26</div></div>
|
|
<div class="ttc" id="aclassSimulatedAnnealing_html_af5a6ed64727a4594f347289527ff8b9a"><div class="ttname"><a href="classSimulatedAnnealing.html#af5a6ed64727a4594f347289527ff8b9a">SimulatedAnnealing::SimulatedAnnealing</a></div><div class="ttdeci">SimulatedAnnealing()</div><div class="ttdef"><b>Definition:</b> methods.cpp:17</div></div>
|
|
<div class="ttc" id="aclassOptimizationMethod_html_adb01ff9af919dbb2c60eb02512a8c3dc"><div class="ttname"><a href="classOptimizationMethod.html#adb01ff9af919dbb2c60eb02512a8c3dc">OptimizationMethod::execute</a></div><div class="ttdeci">virtual void execute()</div><div class="ttdef"><b>Definition:</b> methods.h:18</div></div>
|
|
<div class="ttc" id="aclassOptimizationMethod_html_aa91c542184436065dc1dc2cac3ada639"><div class="ttname"><a href="classOptimizationMethod.html#aa91c542184436065dc1dc2cac3ada639">OptimizationMethod::initialise</a></div><div class="ttdeci">virtual void initialise()</div><div class="ttdef"><b>Definition:</b> methods.h:17</div></div>
|
|
<div class="ttc" id="aclassSimulatedAnnealing_html_a28b0004727cd54ad17c13c0da33168f1"><div class="ttname"><a href="classSimulatedAnnealing.html#a28b0004727cd54ad17c13c0da33168f1">SimulatedAnnealing::execute</a></div><div class="ttdeci">void execute()</div><div class="ttdef"><b>Definition:</b> methods.cpp:85</div></div>
|
|
<div class="ttc" id="aclassOptimizationMethod_html_ae74af2b7ddb2720db1bc1554d577a1a6"><div class="ttname"><a href="classOptimizationMethod.html#ae74af2b7ddb2720db1bc1554d577a1a6">OptimizationMethod::finalise</a></div><div class="ttdeci">virtual void finalise() const =0</div></div>
|
|
<div class="ttc" id="aclassOptimizationMethod_html_a8490a7cd0e3334f7e61469377c7d4217"><div class="ttname"><a href="classOptimizationMethod.html#a8490a7cd0e3334f7e61469377c7d4217">OptimizationMethod::OptimizationMethod</a></div><div class="ttdeci">OptimizationMethod()</div><div class="ttdef"><b>Definition:</b> methods.h:13</div></div>
|
|
<div class="ttc" id="aclassSimulatedAnnealing_html_a2bb082c85be4814998b9f54ca6f05f7f"><div class="ttname"><a href="classSimulatedAnnealing.html#a2bb082c85be4814998b9f54ca6f05f7f">SimulatedAnnealing::initialise</a></div><div class="ttdeci">void initialise()</div><div class="ttdef"><b>Definition:</b> methods.cpp:75</div></div>
|
|
<div class="ttc" id="aclassOptimizationMethod_html_ab33ddd12499ebedbc73f125a65a21442"><div class="ttname"><a href="classOptimizationMethod.html#ab33ddd12499ebedbc73f125a65a21442">OptimizationMethod::~OptimizationMethod</a></div><div class="ttdeci">virtual ~OptimizationMethod()</div><div class="ttdef"><b>Definition:</b> methods.h:15</div></div>
|
|
<div class="ttc" id="aclassOptimizationMethod_html_afe937854a5a30a514dc0414342132630"><div class="ttname"><a href="classOptimizationMethod.html#afe937854a5a30a514dc0414342132630">OptimizationMethod::OptimizationMethod</a></div><div class="ttdeci">OptimizationMethod(Model *A)</div><div class="ttdef"><b>Definition:</b> methods.h:14</div></div>
|
|
<div class="ttc" id="aclassOptimizationMethod_html"><div class="ttname"><a href="classOptimizationMethod.html">OptimizationMethod</a></div><div class="ttdef"><b>Definition:</b> methods.h:10</div></div>
|
|
<div class="ttc" id="aclassOptimizationMethod_html_a8facd4ec032c5613003238d88a3354de"><div class="ttname"><a href="classOptimizationMethod.html#a8facd4ec032c5613003238d88a3354de">OptimizationMethod::ToAdjust</a></div><div class="ttdeci">Model * ToAdjust</div><div class="ttdef"><b>Definition:</b> methods.h:21</div></div>
|
|
<div class="ttc" id="aclassSimulatedAnnealing_html_a6c76ea1faede9c60a8dd732b6a26efea"><div class="ttname"><a href="classSimulatedAnnealing.html#a6c76ea1faede9c60a8dd732b6a26efea">SimulatedAnnealing::finalise</a></div><div class="ttdeci">void finalise() const</div><div class="ttdef"><b>Definition:</b> methods.cpp:114</div></div>
|
|
<div class="ttc" id="amodels_8h_html"><div class="ttname"><a href="models_8h.html">models.h</a></div></div>
|
|
<div class="ttc" id="aclassModel_html"><div class="ttname"><a href="classModel.html">Model</a></div><div class="ttdef"><b>Definition:</b> models.h:11</div></div>
|
|
<div class="ttc" id="aclassSimulatedAnnealing_html_ab8630a5a98e257bab37f9b998329e397"><div class="ttname"><a href="classSimulatedAnnealing.html#ab8630a5a98e257bab37f9b998329e397">SimulatedAnnealing::~SimulatedAnnealing</a></div><div class="ttdeci">~SimulatedAnnealing()</div><div class="ttdef"><b>Definition:</b> methods.h:32</div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|