paradiseo/trunk/paradiseo-mo/doc/html/mo_s_a_8h-source.html
jboisson 25cf44c291 New doc is made
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@742 331e1502-861f-0410-8da2-ba01fb791d7f
2007-10-23 13:38:14 +00:00

176 lines
16 KiB
HTML

<!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.h Source File</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><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><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>
<h1>moSA.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* </span>
<a name="l00002"></a>00002 <span class="comment">* &lt;moSA.h&gt;</span>
<a name="l00003"></a>00003 <span class="comment">* Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2007</span>
<a name="l00004"></a>00004 <span class="comment">* (C) OPAC Team, LIFL, 2002-2007</span>
<a name="l00005"></a>00005 <span class="comment">*</span>
<a name="l00006"></a>00006 <span class="comment">* Sébastien Cahon, Jean-Charles Boisson (Jean-Charles.Boisson@lifl.fr)</span>
<a name="l00007"></a>00007 <span class="comment">*</span>
<a name="l00008"></a>00008 <span class="comment">* This software is governed by the CeCILL license under French law and</span>
<a name="l00009"></a>00009 <span class="comment">* abiding by the rules of distribution of free software. You can use,</span>
<a name="l00010"></a>00010 <span class="comment">* modify and/ or redistribute the software under the terms of the CeCILL</span>
<a name="l00011"></a>00011 <span class="comment">* license as circulated by CEA, CNRS and INRIA at the following URL</span>
<a name="l00012"></a>00012 <span class="comment">* "http://www.cecill.info".</span>
<a name="l00013"></a>00013 <span class="comment">*</span>
<a name="l00014"></a>00014 <span class="comment">* As a counterpart to the access to the source code and rights to copy,</span>
<a name="l00015"></a>00015 <span class="comment">* modify and redistribute granted by the license, users are provided only</span>
<a name="l00016"></a>00016 <span class="comment">* with a limited warranty and the software's author, the holder of the</span>
<a name="l00017"></a>00017 <span class="comment">* economic rights, and the successive licensors have only limited liability.</span>
<a name="l00018"></a>00018 <span class="comment">*</span>
<a name="l00019"></a>00019 <span class="comment">* In this respect, the user's attention is drawn to the risks associated</span>
<a name="l00020"></a>00020 <span class="comment">* with loading, using, modifying and/or developing or reproducing the</span>
<a name="l00021"></a>00021 <span class="comment">* software by the user in light of its specific status of free software,</span>
<a name="l00022"></a>00022 <span class="comment">* that may mean that it is complicated to manipulate, and that also</span>
<a name="l00023"></a>00023 <span class="comment">* therefore means that it is reserved for developers and experienced</span>
<a name="l00024"></a>00024 <span class="comment">* professionals having in-depth computer knowledge. Users are therefore</span>
<a name="l00025"></a>00025 <span class="comment">* encouraged to load and test the software's suitability as regards their</span>
<a name="l00026"></a>00026 <span class="comment">* requirements in conditions enabling the security of their systems and/or</span>
<a name="l00027"></a>00027 <span class="comment">* data to be ensured and, more generally, to use and operate it in the</span>
<a name="l00028"></a>00028 <span class="comment">* same conditions as regards security.</span>
<a name="l00029"></a>00029 <span class="comment">* The fact that you are presently reading this means that you have had</span>
<a name="l00030"></a>00030 <span class="comment">* knowledge of the CeCILL license and that you accept its terms.</span>
<a name="l00031"></a>00031 <span class="comment">*</span>
<a name="l00032"></a>00032 <span class="comment">* ParadisEO WebSite : http://paradiseo.gforge.inria.fr</span>
<a name="l00033"></a>00033 <span class="comment">* Contact: paradiseo-help@lists.gforge.inria.fr</span>
<a name="l00034"></a>00034 <span class="comment">*</span>
<a name="l00035"></a>00035 <span class="comment">*/</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="preprocessor">#ifndef __moSA_h</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define __moSA_h</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include &lt;eoOp.h&gt;</span>
<a name="l00041"></a>00041 <span class="preprocessor">#include &lt;eoEvalFunc.h&gt;</span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="preprocessor">#include "moAlgo.h"</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include "moRandMove.h"</span>
<a name="l00045"></a>00045 <span class="preprocessor">#include "moMoveIncrEval.h"</span>
<a name="l00046"></a>00046 <span class="preprocessor">#include "moCoolingSchedule.h"</span>
<a name="l00047"></a>00047 <span class="preprocessor">#include "moSolContinue.h"</span>
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="preprocessor">#include &lt;math.h&gt;</span>
<a name="l00050"></a>00050
<a name="l00052"></a>00052
<a name="l00055"></a><a class="code" href="classmo_s_a.html">00055</a> <span class="keyword">template</span> &lt; <span class="keyword">class</span> M &gt; <span class="keyword">class </span><a class="code" href="classmo_s_a.html" title="Simulated Annealing (SA).">moSA</a>:<span class="keyword">public</span> <a class="code" href="classmo_algo.html" title="Description of an algorithm of the paradiseo-mo library.">moAlgo</a> &lt; typename M::EOType &gt;
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057
<a name="l00059"></a>00059 <span class="keyword">typedef</span>
<a name="l00060"></a>00060 <span class="keyword">typename</span>
<a name="l00061"></a>00061 M::EOType
<a name="l00062"></a><a class="code" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5">00062</a> <a class="code" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5" title="Alias for the type.">EOT</a>;
<a name="l00063"></a>00063
<a name="l00065"></a>00065 <span class="keyword">typedef</span>
<a name="l00066"></a>00066 <span class="keyword">typename</span>
<a name="l00067"></a>00067 EOT::Fitness
<a name="l00068"></a><a class="code" href="classmo_s_a.html#97f1a40d5ab5a0b3f878d0347b34804b">00068</a> <a class="code" href="classmo_s_a.html#97f1a40d5ab5a0b3f878d0347b34804b" title="Alias for the fitness.">Fitness</a>;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keyword">public</span>:
<a name="l00071"></a>00071
<a name="l00073"></a>00073
<a name="l00083"></a><a class="code" href="classmo_s_a.html#01f6a44483e5a7abbce33eb480b6a9b9">00083</a> <a class="code" href="classmo_s_a.html#01f6a44483e5a7abbce33eb480b6a9b9" title="SA constructor.">moSA</a> (moRandMove &lt; M &gt; &amp;__move_rand,
<a name="l00084"></a>00084 moMoveIncrEval &lt; M &gt; &amp;__incr_eval,
<a name="l00085"></a>00085 moSolContinue &lt; EOT &gt; &amp;__cont,
<a name="l00086"></a>00086 <span class="keywordtype">double</span> __init_temp,
<a name="l00087"></a>00087 <a class="code" href="classmo_cooling_schedule.html" title="This class gives the description of a cooling schedule.">moCoolingSchedule</a> &amp; __cool_sched, eoEvalFunc &lt; EOT &gt; &amp;__full_eval):
<a name="l00088"></a>00088 <a class="code" href="classmo_s_a.html#71c49935b63a202d25888a5f86121fec" title="A move generator (generally randomly).">move_rand</a> (__move_rand),
<a name="l00089"></a>00089 <a class="code" href="classmo_s_a.html#4c3be32e9832e465b24e6d33559356bc" title="A (generally) efficient evaluation function.">incr_eval</a> (__incr_eval),
<a name="l00090"></a>00090 <a class="code" href="classmo_s_a.html#54484c8a514866ea496e0058c2e09716" title="Stopping criterion before temperature update.">cont</a> (__cont),
<a name="l00091"></a>00091 <a class="code" href="classmo_s_a.html#f1af7636b52aa5f6b381f8187b667bd4" title="Initial temperature.">init_temp</a> (__init_temp),
<a name="l00092"></a>00092 <a class="code" href="classmo_s_a.html#11c7d0cab649b7d680dd85bb74cb4ff6" title="The cooling schedule.">cool_sched</a> (__cool_sched),
<a name="l00093"></a>00093 <a class="code" href="classmo_s_a.html#bcd6a940046f23dd741444c0b85edf2c" title="A full evaluation function.">full_eval</a> (__full_eval)
<a name="l00094"></a>00094 {
<a name="l00095"></a>00095
<a name="l00096"></a>00096 }
<a name="l00097"></a>00097
<a name="l00099"></a>00099
<a name="l00105"></a><a class="code" href="classmo_s_a.html#0e4c54b57bc13fcbd4763883b8f719e5">00105</a> <span class="keywordtype">bool</span> <a class="code" href="classmo_s_a.html#0e4c54b57bc13fcbd4763883b8f719e5" title="function that launches the SA algorithm.">operator ()</a>(<a class="code" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5" title="Alias for the type.">EOT</a> &amp; __sol)
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keywordflow">if</span> (__sol.invalid ())
<a name="l00109"></a>00109 {
<a name="l00110"></a>00110 <a class="code" href="classmo_s_a.html#bcd6a940046f23dd741444c0b85edf2c" title="A full evaluation function.">full_eval</a> (__sol);
<a name="l00111"></a>00111 }
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keywordtype">double</span> temp = <a class="code" href="classmo_s_a.html#f1af7636b52aa5f6b381f8187b667bd4" title="Initial temperature.">init_temp</a>;
<a name="l00114"></a>00114
<a name="l00115"></a>00115 M move;
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <a class="code" href="classmo_s_a.html#d5d64a8797bdedc7b3af7893aded0bd5" title="Alias for the type.">EOT</a> best_sol = __sol;
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="keywordflow">do</span>
<a name="l00120"></a>00120 {
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <a class="code" href="classmo_s_a.html#54484c8a514866ea496e0058c2e09716" title="Stopping criterion before temperature update.">cont</a>.init ();
<a name="l00123"></a>00123 <span class="keywordflow">do</span>
<a name="l00124"></a>00124 {
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <a class="code" href="classmo_s_a.html#71c49935b63a202d25888a5f86121fec" title="A move generator (generally randomly).">move_rand</a> (move);
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <a class="code" href="classmo_s_a.html#97f1a40d5ab5a0b3f878d0347b34804b" title="Alias for the fitness.">Fitness</a> delta_fit = <a class="code" href="classmo_s_a.html#4c3be32e9832e465b24e6d33559356bc" title="A (generally) efficient evaluation function.">incr_eval</a> (move, __sol) - __sol.fitness ();
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="keywordflow">if</span> (delta_fit &gt; 0 || rng.<a class="codeRef" doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_rng.html#50dfb052f11ae50326e552cb223d88e4">uniform</a> () &lt; exp (delta_fit / temp))
<a name="l00131"></a>00131 {
<a name="l00132"></a>00132
<a name="l00133"></a>00133 __sol.fitness (<a class="code" href="classmo_s_a.html#4c3be32e9832e465b24e6d33559356bc" title="A (generally) efficient evaluation function.">incr_eval</a> (move, __sol));
<a name="l00134"></a>00134 move (__sol);
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="comment">/* Updating the best solution found</span>
<a name="l00137"></a>00137 <span class="comment"> until now ? */</span>
<a name="l00138"></a>00138 <span class="keywordflow">if</span> (__sol.fitness () &gt; best_sol.fitness ())
<a name="l00139"></a>00139 best_sol = __sol;
<a name="l00140"></a>00140 }
<a name="l00141"></a>00141
<a name="l00142"></a>00142 }
<a name="l00143"></a>00143 <span class="keywordflow">while</span> (<a class="code" href="classmo_s_a.html#54484c8a514866ea496e0058c2e09716" title="Stopping criterion before temperature update.">cont</a> (__sol));
<a name="l00144"></a>00144
<a name="l00145"></a>00145 }
<a name="l00146"></a>00146 <span class="keywordflow">while</span> (<a class="code" href="classmo_s_a.html#11c7d0cab649b7d680dd85bb74cb4ff6" title="The cooling schedule.">cool_sched</a> (temp));
<a name="l00147"></a>00147
<a name="l00148"></a>00148 __sol = best_sol;
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00151"></a>00151 }
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="keyword">private</span>:
<a name="l00154"></a>00154
<a name="l00156"></a><a class="code" href="classmo_s_a.html#71c49935b63a202d25888a5f86121fec">00156</a> moRandMove &lt; M &gt; &amp;<a class="code" href="classmo_s_a.html#71c49935b63a202d25888a5f86121fec" title="A move generator (generally randomly).">move_rand</a>;
<a name="l00157"></a>00157
<a name="l00159"></a><a class="code" href="classmo_s_a.html#4c3be32e9832e465b24e6d33559356bc">00159</a> moMoveIncrEval &lt; M &gt; &amp;<a class="code" href="classmo_s_a.html#4c3be32e9832e465b24e6d33559356bc" title="A (generally) efficient evaluation function.">incr_eval</a>;
<a name="l00160"></a>00160
<a name="l00162"></a><a class="code" href="classmo_s_a.html#54484c8a514866ea496e0058c2e09716">00162</a> moSolContinue &lt; EOT &gt; &amp;<a class="code" href="classmo_s_a.html#54484c8a514866ea496e0058c2e09716" title="Stopping criterion before temperature update.">cont</a>;
<a name="l00163"></a>00163
<a name="l00165"></a><a class="code" href="classmo_s_a.html#f1af7636b52aa5f6b381f8187b667bd4">00165</a> <span class="keywordtype">double</span> <a class="code" href="classmo_s_a.html#f1af7636b52aa5f6b381f8187b667bd4" title="Initial temperature.">init_temp</a>;
<a name="l00166"></a>00166
<a name="l00168"></a><a class="code" href="classmo_s_a.html#11c7d0cab649b7d680dd85bb74cb4ff6">00168</a> <a class="code" href="classmo_cooling_schedule.html" title="This class gives the description of a cooling schedule.">moCoolingSchedule</a> &amp; <a class="code" href="classmo_s_a.html#11c7d0cab649b7d680dd85bb74cb4ff6" title="The cooling schedule.">cool_sched</a>;
<a name="l00169"></a>00169
<a name="l00171"></a><a class="code" href="classmo_s_a.html#bcd6a940046f23dd741444c0b85edf2c">00171</a> eoEvalFunc &lt; EOT &gt; &amp;<a class="code" href="classmo_s_a.html#bcd6a940046f23dd741444c0b85edf2c" title="A full evaluation function.">full_eval</a>; <span class="comment">// Full evaluator.</span>
<a name="l00172"></a>00172 };
<a name="l00173"></a>00173
<a name="l00174"></a>00174 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Tue Oct 23 15:29:28 2007 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.2 </small></address>
</body>
</html>