nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/paradiseo-mo/doc/html/classmo_s_a.html
jboisson 7a47863fd2 I have forgotten to regenerate the documentation, it is done 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@589 331e1502-861f-0410-8da2-ba01fb791d7f
2007-08-03 14:40:30 +00:00

216 lines
16 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-MO: 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.2 -->
<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>
<p>Inheritance diagram for moSA&lt; M &gt;:
<p><center><img src="classmo_s_a.png" usemap="#moSA< M >_map" border="0" alt=""></center>
<map name="moSA< M >_map">
<area href="classmo_algo.html" alt="moAlgo< M::EOType >" shape="rect" coords="93,168,269,192">
<area doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_mon_op.html" alt="eoMonOp< M::EOType >" shape="rect" coords="93,112,269,136">
<area doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_op.html" alt="eoOp< EOType >" shape="rect" coords="0,56,176,80">
<area doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_u_f.html" alt="eoUF< M::EOType &, bool >" shape="rect" coords="186,56,362,80">
<area doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_functor_base.html" alt="eoFunctorBase" shape="rect" coords="186,0,362,24">
</map>
<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#01f6a44483e5a7abbce33eb480b6a9b9">moSA</a> (<a class="el" href="classmo_rand_move.html">moRandMove</a>&lt; M &gt; &amp;__move_rand, <a class="el" href="classmo_move_incr_eval.html">moMoveIncrEval</a>&lt; M &gt; &amp;__incr_eval, <a class="el" href="classmo_sol_continue.html">moSolContinue</a>&lt; <a class="el" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">EOT</a> &gt; &amp;__cont, double __init_temp, <a class="el" href="classmo_cooling_schedule.html">moCoolingSchedule</a> &amp;__cool_sched, <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_eval)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">SA constructor. <a href="#01f6a44483e5a7abbce33eb480b6a9b9"></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#0e4c54b57bc13fcbd4763883b8f719e5">operator()</a> (<a class="el" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">EOT</a> &amp;__sol)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">function that launches the SA algorithm. <a href="#0e4c54b57bc13fcbd4763883b8f719e5"></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="71c49935b63a202d25888a5f86121fec"></a><!-- doxytag: member="moSA::move_rand" ref="71c49935b63a202d25888a5f86121fec" 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#71c49935b63a202d25888a5f86121fec">move_rand</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="4c3be32e9832e465b24e6d33559356bc"></a><!-- doxytag: member="moSA::incr_eval" ref="4c3be32e9832e465b24e6d33559356bc" 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#4c3be32e9832e465b24e6d33559356bc">incr_eval</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="54484c8a514866ea496e0058c2e09716"></a><!-- doxytag: member="moSA::cont" ref="54484c8a514866ea496e0058c2e09716" 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#54484c8a514866ea496e0058c2e09716">cont</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="f1af7636b52aa5f6b381f8187b667bd4"></a><!-- doxytag: member="moSA::init_temp" ref="f1af7636b52aa5f6b381f8187b667bd4" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_s_a.html#f1af7636b52aa5f6b381f8187b667bd4">init_temp</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="11c7d0cab649b7d680dd85bb74cb4ff6"></a><!-- doxytag: member="moSA::cool_sched" ref="11c7d0cab649b7d680dd85bb74cb4ff6" 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#11c7d0cab649b7d680dd85bb74cb4ff6">cool_sched</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="bcd6a940046f23dd741444c0b85edf2c"></a><!-- doxytag: member="moSA::full_eval" ref="bcd6a940046f23dd741444c0b85edf2c" 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#bcd6a940046f23dd741444c0b85edf2c">full_eval</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>
<p>
Definition at line <a class="el" href="mo_s_a_8h-source.html#l00030">30</a> of file <a class="el" href="mo_s_a_8h-source.html">moSA.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="01f6a44483e5a7abbce33eb480b6a9b9"></a><!-- doxytag: member="moSA::moSA" ref="01f6a44483e5a7abbce33eb480b6a9b9" args="(moRandMove&lt; M &gt; &amp;__move_rand, moMoveIncrEval&lt; M &gt; &amp;__incr_eval, moSolContinue&lt; EOT &gt; &amp;__cont, double __init_temp, moCoolingSchedule &amp;__cool_sched, eoEvalFunc&lt; EOT &gt; &amp;__full_eval)" -->
<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>__move_rand</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>__incr_eval</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>__cont</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>__init_temp</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>__cool_sched</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_eval</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>__move_rand</em>&nbsp;</td><td>a move generator (generally randomly). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__incr_eval</em>&nbsp;</td><td>a (generaly) efficient evaluation function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__cont</em>&nbsp;</td><td>a stopping criterion. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__init_temp</em>&nbsp;</td><td>the initial temperature. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__cool_sched</em>&nbsp;</td><td>a cooling schedule, describes how the temperature is modified. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__full_eval</em>&nbsp;</td><td>a full evaluation function. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="mo_s_a_8h-source.html#l00052">52</a> of file <a class="el" href="mo_s_a_8h-source.html">moSA.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0e4c54b57bc13fcbd4763883b8f719e5"></a><!-- doxytag: member="moSA::operator()" ref="0e4c54b57bc13fcbd4763883b8f719e5" args="(EOT &amp;__sol)" -->
<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>__sol</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>__sol</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>
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>
References <a class="el" href="mo_s_a_8h-source.html#l00137">moSA&lt; M &gt;::cont</a>, <a class="el" href="mo_s_a_8h-source.html#l00143">moSA&lt; M &gt;::cool_sched</a>, <a class="el" href="mo_s_a_8h-source.html#l00146">moSA&lt; M &gt;::full_eval</a>, <a class="el" href="mo_s_a_8h-source.html#l00134">moSA&lt; M &gt;::incr_eval</a>, <a class="el" href="mo_s_a_8h-source.html#l00140">moSA&lt; M &gt;::init_temp</a>, <a class="el" href="mo_s_a_8h-source.html#l00131">moSA&lt; M &gt;::move_rand</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>.
</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 Fri Aug 3 16:38:57 2007 for PARADISEO-MO by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink