nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/branches/cmakemodif/paradiseo-mo/doc/html/classmo_s_a.html
jhumeau 350bdfc7de modif cmake configuration 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@1277 331e1502-861f-0410-8da2-ba01fb791d7f
2008-12-03 14:41:25 +00:00

209 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ParadisEO-MOMovingObjects: moSA&lt; M &gt; Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.4 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<h1>moSA&lt; M &gt; Class Template Reference</h1><!-- doxytag: class="moSA" --><!-- doxytag: inherits="moAlgo&lt; M::EOType &gt;" -->Simulated Annealing (SA).
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_s_a_8h-source.html">moSA.h</a>&gt;</code>
<p>
Inherits <a class="el" href="classmo_algo.html">moAlgo&lt; M::EOType &gt;</a>.
<p>
<p>
<a href="classmo_s_a-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_s_a.html#12e7da3a56b82daa29a30d1254da5823">moSA</a> (<a class="el" href="classmo_rand_move.html">moRandMove</a>&lt; M &gt; &amp;_random_move_generator, <a class="el" href="classmo_move_incr_eval.html">moMoveIncrEval</a>&lt; M &gt; &amp;_incremental_evaluation, <a class="el" href="classmo_sol_continue.html">moSolContinue</a>&lt; <a class="el" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">EOT</a> &gt; &amp;_continue, double _initial_temperature, <a class="el" href="classmo_cooling_schedule.html">moCoolingSchedule</a> &amp;_cooling_schedule, <a class="elRef" doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_eval_func.html">eoEvalFunc</a>&lt; <a class="el" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">EOT</a> &gt; &amp;_full_evaluation)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">SA constructor. <a href="#12e7da3a56b82daa29a30d1254da5823"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_s_a.html#bea8176b0c05a96696b2ab29d3f3c544">operator()</a> (<a class="el" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">EOT</a> &amp;_solution)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function that launches the SA algorithm. <a href="#bea8176b0c05a96696b2ab29d3f3c544"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d5d64a8797bdedc7b3af7893aded0bd5"></a><!-- doxytag: member="moSA::EOT" ref="d5d64a8797bdedc7b3af7893aded0bd5" args="" -->
typedef M::EOType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">EOT</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alias for the type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="97f1a40d5ab5a0b3f878d0347b34804b"></a><!-- doxytag: member="moSA::Fitness" ref="97f1a40d5ab5a0b3f878d0347b34804b" args="" -->
typedef EOT::Fitness&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_s_a.html#97f1a40d5ab5a0b3f878d0347b34804b">Fitness</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alias for the fitness. <br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="92656523f556669862fcffdccea178dd"></a><!-- doxytag: member="moSA::random_move_generator" ref="92656523f556669862fcffdccea178dd" args="" -->
<a class="el" href="classmo_rand_move.html">moRandMove</a>&lt; M &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_s_a.html#92656523f556669862fcffdccea178dd">random_move_generator</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A move generator (generally randomly). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fdb49f837dc602624554279418c94bdb"></a><!-- doxytag: member="moSA::incremental_evaluation" ref="fdb49f837dc602624554279418c94bdb" args="" -->
<a class="el" href="classmo_move_incr_eval.html">moMoveIncrEval</a>&lt; M &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_s_a.html#fdb49f837dc602624554279418c94bdb">incremental_evaluation</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A (generally) efficient evaluation function. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="776586a839c2bbd6d12a731c12a1b748"></a><!-- doxytag: member="moSA::continu" ref="776586a839c2bbd6d12a731c12a1b748" args="" -->
<a class="el" href="classmo_sol_continue.html">moSolContinue</a>&lt; <a class="el" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">EOT</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_s_a.html#776586a839c2bbd6d12a731c12a1b748">continu</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stopping criterion before temperature update. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e07bf4ca64248e94ab85e8a1ba32aa8c"></a><!-- doxytag: member="moSA::initial_temperature" ref="e07bf4ca64248e94ab85e8a1ba32aa8c" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_s_a.html#e07bf4ca64248e94ab85e8a1ba32aa8c">initial_temperature</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initial temperature. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f514ae01cdfc67bf0b87d5389b3792e5"></a><!-- doxytag: member="moSA::cooling_schedule" ref="f514ae01cdfc67bf0b87d5389b3792e5" args="" -->
<a class="el" href="classmo_cooling_schedule.html">moCoolingSchedule</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_s_a.html#f514ae01cdfc67bf0b87d5389b3792e5">cooling_schedule</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The cooling schedule. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ace30095ffc4924d84e14a0e59f7746f"></a><!-- doxytag: member="moSA::full_evaluation" ref="ace30095ffc4924d84e14a0e59f7746f" args="" -->
<a class="elRef" doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_eval_func.html">eoEvalFunc</a>&lt; <a class="el" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">EOT</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_s_a.html#ace30095ffc4924d84e14a0e59f7746f">full_evaluation</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A full evaluation function. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class M&gt;<br>
class moSA&lt; M &gt;</h3>
Simulated Annealing (SA).
<p>
Class that describes a Simulated Annealing algorithm.
<p>Definition at line <a class="el" href="mo_s_a_8h-source.html#l00053">53</a> of file <a class="el" href="mo_s_a_8h-source.html">moSA.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="12e7da3a56b82daa29a30d1254da5823"></a><!-- doxytag: member="moSA::moSA" ref="12e7da3a56b82daa29a30d1254da5823" args="(moRandMove&lt; M &gt; &amp;_random_move_generator, moMoveIncrEval&lt; M &gt; &amp;_incremental_evaluation, moSolContinue&lt; EOT &gt; &amp;_continue, double _initial_temperature, moCoolingSchedule &amp;_cooling_schedule, eoEvalFunc&lt; EOT &gt; &amp;_full_evaluation)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class M&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmo_s_a.html">moSA</a>&lt; M &gt;::<a class="el" href="classmo_s_a.html">moSA</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmo_rand_move.html">moRandMove</a>&lt; M &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_random_move_generator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmo_move_incr_eval.html">moMoveIncrEval</a>&lt; M &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_incremental_evaluation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmo_sol_continue.html">moSolContinue</a>&lt; <a class="el" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">EOT</a> &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_continue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>_initial_temperature</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmo_cooling_schedule.html">moCoolingSchedule</a> &amp;&nbsp;</td>
<td class="paramname"> <em>_cooling_schedule</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_eval_func.html">eoEvalFunc</a>&lt; <a class="el" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">EOT</a> &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_full_evaluation</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
SA constructor.
<p>
All the boxes used by a SA need to be given.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_random_move_generator</em>&nbsp;</td><td>The move generator (generally randomly). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_incremental_evaluation</em>&nbsp;</td><td>The (generally) efficient evaluation function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_continue</em>&nbsp;</td><td>The stopping criterion. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_initial_temperature</em>&nbsp;</td><td>The initial temperature. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_cooling_schedule</em>&nbsp;</td><td>The cooling schedule, describes how the temperature is modified. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_full_evaluation</em>&nbsp;</td><td>The full evaluation function. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="mo_s_a_8h-source.html#l00074">74</a> of file <a class="el" href="mo_s_a_8h-source.html">moSA.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="bea8176b0c05a96696b2ab29d3f3c544"></a><!-- doxytag: member="moSA::operator()" ref="bea8176b0c05a96696b2ab29d3f3c544" args="(EOT &amp;_solution)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class M&gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmo_s_a.html">moSA</a>&lt; M &gt;::operator() </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">EOT</a> &amp;&nbsp;</td>
<td class="paramname"> <em>_solution</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
function that launches the SA algorithm.
<p>
As a <a class="el" href="classmo_t_s.html" title="Tabu Search (TS).">moTS</a> or a <a class="el" href="classmo_h_c.html" title="Hill Climbing (HC).">moHC</a>, the SA can be used for HYBRIDATION in an evolutionary algorithm.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_solution</em>&nbsp;</td><td>A solution to improve. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE. </dd></dl>
<p>Implements <a class="elRef" doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_u_f.html#786e028409366dc273e19104f17ba68a">eoUF&lt; M::EOType &amp;, bool &gt;</a>.</p>
<p>Definition at line <a class="el" href="mo_s_a_8h-source.html#l00089">89</a> of file <a class="el" href="mo_s_a_8h-source.html">moSA.h</a>.</p>
<p>References <a class="el" href="mo_s_a_8h-source.html#l00153">moSA&lt; M &gt;::continu</a>, <a class="el" href="mo_s_a_8h-source.html#l00159">moSA&lt; M &gt;::cooling_schedule</a>, <a class="el" href="mo_s_a_8h-source.html#l00162">moSA&lt; M &gt;::full_evaluation</a>, <a class="el" href="mo_s_a_8h-source.html#l00150">moSA&lt; M &gt;::incremental_evaluation</a>, <a class="el" href="mo_s_a_8h-source.html#l00156">moSA&lt; M &gt;::initial_temperature</a>, <a class="el" href="mo_s_a_8h-source.html#l00147">moSA&lt; M &gt;::random_move_generator</a>, and <a class="elRef" doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_rng.html#50dfb052f11ae50326e552cb223d88e4">eoRng::uniform()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mo_s_a_8h-source.html">moSA.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jan 16 15:50:41 2008 for ParadisEO-MOMovingObjects by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink