1
0
Files
SimulatedAnnealing/Rapport/html/classSimulatedAnnealing.html
2023-12-31 15:42:33 +01:00

338 lines
16 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: SimulatedAnnealing 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="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&amp;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&amp;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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">SimulatedAnnealing Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="methods_8h_source.html">methods.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SimulatedAnnealing:</div>
<div class="dyncontent">
<div class="center"><img src="classSimulatedAnnealing__inherit__graph.png" border="0" usemap="#SimulatedAnnealing_inherit__map" alt="Inheritance graph"/></div>
<map name="SimulatedAnnealing_inherit__map" id="SimulatedAnnealing_inherit__map">
<area shape="rect" title=" " alt="" coords="6,204,171,369"/>
<area shape="rect" href="classOptimizationMethod.html" title=" " alt="" coords="5,5,172,156"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for SimulatedAnnealing:</div>
<div class="dyncontent">
<div class="center"><img src="classSimulatedAnnealing__coll__graph.png" border="0" usemap="#SimulatedAnnealing_coll__map" alt="Collaboration graph"/></div>
<map name="SimulatedAnnealing_coll__map" id="SimulatedAnnealing_coll__map">
<area shape="rect" title=" " alt="" coords="56,837,221,1003"/>
<area shape="rect" href="classOptimizationMethod.html" title=" " alt="" coords="55,637,222,788"/>
<area shape="rect" href="classModel.html" title=" " alt="" coords="77,307,200,575"/>
<area shape="rect" href="classCostFunction.html" title=" " alt="" coords="5,57,133,178"/>
<area shape="rect" href="classData.html" title=" " alt="" coords="158,5,258,229"/>
</map>
</div>
<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:af5a6ed64727a4594f347289527ff8b9a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimulatedAnnealing.html#af5a6ed64727a4594f347289527ff8b9a">SimulatedAnnealing</a> ()</td></tr>
<tr class="separator:af5a6ed64727a4594f347289527ff8b9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58dfcf46592210e4ea5372bf39b16042"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimulatedAnnealing.html#a58dfcf46592210e4ea5372bf39b16042">SimulatedAnnealing</a> (<a class="el" href="classModel.html">Model</a> *)</td></tr>
<tr class="separator:a58dfcf46592210e4ea5372bf39b16042"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3dbfb1da9bf3f9e1ce023bbd1505b99"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimulatedAnnealing.html#aa3dbfb1da9bf3f9e1ce023bbd1505b99">SimulatedAnnealing</a> (<a class="el" href="classModel.html">Model</a> *, double, double, double, double, int, int)</td></tr>
<tr class="separator:aa3dbfb1da9bf3f9e1ce023bbd1505b99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8630a5a98e257bab37f9b998329e397"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimulatedAnnealing.html#ab8630a5a98e257bab37f9b998329e397">~SimulatedAnnealing</a> ()</td></tr>
<tr class="separator:ab8630a5a98e257bab37f9b998329e397"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bb082c85be4814998b9f54ca6f05f7f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimulatedAnnealing.html#a2bb082c85be4814998b9f54ca6f05f7f">initialise</a> ()</td></tr>
<tr class="separator:a2bb082c85be4814998b9f54ca6f05f7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28b0004727cd54ad17c13c0da33168f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimulatedAnnealing.html#a28b0004727cd54ad17c13c0da33168f1">execute</a> ()</td></tr>
<tr class="separator:a28b0004727cd54ad17c13c0da33168f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c76ea1faede9c60a8dd732b6a26efea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimulatedAnnealing.html#a6c76ea1faede9c60a8dd732b6a26efea">finalise</a> () const</td></tr>
<tr class="separator:a6c76ea1faede9c60a8dd732b6a26efea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classOptimizationMethod"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classOptimizationMethod')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classOptimizationMethod.html">OptimizationMethod</a></td></tr>
<tr class="memitem:a8490a7cd0e3334f7e61469377c7d4217 inherit pub_methods_classOptimizationMethod"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOptimizationMethod.html#a8490a7cd0e3334f7e61469377c7d4217">OptimizationMethod</a> ()</td></tr>
<tr class="separator:a8490a7cd0e3334f7e61469377c7d4217 inherit pub_methods_classOptimizationMethod"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe937854a5a30a514dc0414342132630 inherit pub_methods_classOptimizationMethod"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOptimizationMethod.html#afe937854a5a30a514dc0414342132630">OptimizationMethod</a> (<a class="el" href="classModel.html">Model</a> *A)</td></tr>
<tr class="separator:afe937854a5a30a514dc0414342132630 inherit pub_methods_classOptimizationMethod"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab33ddd12499ebedbc73f125a65a21442 inherit pub_methods_classOptimizationMethod"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOptimizationMethod.html#ab33ddd12499ebedbc73f125a65a21442">~OptimizationMethod</a> ()</td></tr>
<tr class="separator:ab33ddd12499ebedbc73f125a65a21442 inherit pub_methods_classOptimizationMethod"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classOptimizationMethod"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classOptimizationMethod')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classOptimizationMethod.html">OptimizationMethod</a></td></tr>
<tr class="memitem:a8facd4ec032c5613003238d88a3354de inherit pro_attribs_classOptimizationMethod"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classModel.html">Model</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOptimizationMethod.html#a8facd4ec032c5613003238d88a3354de">ToAdjust</a></td></tr>
<tr class="separator:a8facd4ec032c5613003238d88a3354de inherit pro_attribs_classOptimizationMethod"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af5a6ed64727a4594f347289527ff8b9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5a6ed64727a4594f347289527ff8b9a">&#9670;&nbsp;</a></span>SimulatedAnnealing() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SimulatedAnnealing::SimulatedAnnealing </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a58dfcf46592210e4ea5372bf39b16042"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58dfcf46592210e4ea5372bf39b16042">&#9670;&nbsp;</a></span>SimulatedAnnealing() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SimulatedAnnealing::SimulatedAnnealing </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classModel.html">Model</a> *&#160;</td>
<td class="paramname"><em>A</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa3dbfb1da9bf3f9e1ce023bbd1505b99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3dbfb1da9bf3f9e1ce023bbd1505b99">&#9670;&nbsp;</a></span>SimulatedAnnealing() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SimulatedAnnealing::SimulatedAnnealing </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classModel.html">Model</a> *&#160;</td>
<td class="paramname"><em>A</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>t_e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>m</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab8630a5a98e257bab37f9b998329e397"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8630a5a98e257bab37f9b998329e397">&#9670;&nbsp;</a></span>~SimulatedAnnealing()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SimulatedAnnealing::~SimulatedAnnealing </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> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a28b0004727cd54ad17c13c0da33168f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28b0004727cd54ad17c13c0da33168f1">&#9670;&nbsp;</a></span>execute()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SimulatedAnnealing::execute </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">
<p>Reimplemented from <a class="el" href="classOptimizationMethod.html#adb01ff9af919dbb2c60eb02512a8c3dc">OptimizationMethod</a>.</p>
</div>
</div>
<a id="a6c76ea1faede9c60a8dd732b6a26efea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c76ea1faede9c60a8dd732b6a26efea">&#9670;&nbsp;</a></span>finalise()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SimulatedAnnealing::finalise </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classOptimizationMethod.html#ae74af2b7ddb2720db1bc1554d577a1a6">OptimizationMethod</a>.</p>
</div>
</div>
<a id="a2bb082c85be4814998b9f54ca6f05f7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bb082c85be4814998b9f54ca6f05f7f">&#9670;&nbsp;</a></span>initialise()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SimulatedAnnealing::initialise </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">
<p>Reimplemented from <a class="el" href="classOptimizationMethod.html#aa91c542184436065dc1dc2cac3ada639">OptimizationMethod</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="methods_8h_source.html">methods.h</a></li>
<li><a class="el" href="methods_8cpp.html">methods.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>