paradiseo/trunk/paradiseo-mo/doc/html/mo_h_c_8h-source.html
jboisson 57ab34591c Documentation is updated
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@889 331e1502-861f-0410-8da2-ba01fb791d7f
2008-01-16 14:53:30 +00:00

124 lines
11 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: moHC.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.4 -->
<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>moHC.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;moHC.h&gt;</span>
<a name="l00003"></a>00003 <span class="comment"> Copyright (C) DOLPHIN Project-Team, INRIA Futurs, 2006-2008</span>
<a name="l00004"></a>00004 <span class="comment"> (C) OPAC Team, LIFL, 2002-2008</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
<a name="l00036"></a>00036 <span class="preprocessor">#ifndef __moHC_h</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define __moHC_h</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span>
<a name="l00039"></a>00039 <span class="preprocessor">#include &lt;eoEvalFunc.h&gt;</span>
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="preprocessor">#include &lt;moAlgo.h&gt;</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include &lt;moHCMoveLoopExpl.h&gt;</span>
<a name="l00043"></a>00043
<a name="l00045"></a>00045
<a name="l00048"></a>00048 <span class="keyword">template</span> &lt; <span class="keyword">class</span> M &gt;
<a name="l00049"></a><a class="code" href="classmo_h_c.html">00049</a> <span class="keyword">class </span><a class="code" href="classmo_h_c.html" title="Hill Climbing (HC).">moHC</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="l00050"></a>00050 {
<a name="l00052"></a><a class="code" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb">00052</a> <span class="keyword">typedef</span> <span class="keyword">typename</span> M::EOType <a class="code" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb" title="Alias for the type.">EOT</a>;
<a name="l00053"></a>00053
<a name="l00055"></a><a class="code" href="classmo_h_c.html#56487c97a7cf0c423cc879d1bbd45027">00055</a> <span class="keyword">typedef</span> <span class="keyword">typename</span> EOT::Fitness <a class="code" href="classmo_h_c.html#56487c97a7cf0c423cc879d1bbd45027" title="Alias for the fitness.">Fitness</a>;
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="keyword">public</span>:
<a name="l00058"></a>00058
<a name="l00060"></a>00060
<a name="l00069"></a><a class="code" href="classmo_h_c.html#44a35bd30df6e79cff95a31b84889bd7">00069</a> <a class="code" href="classmo_h_c.html#44a35bd30df6e79cff95a31b84889bd7" title="Full constructor.">moHC</a> (moMoveInit &lt; M &gt; &amp; _move_initializer, moNextMove &lt; M &gt; &amp; _next_move_generator,
<a name="l00070"></a>00070 moMoveIncrEval &lt; M &gt; &amp; _incremental_evaluation, moMoveSelect &lt; M &gt; &amp; _move_selection, eoEvalFunc &lt; EOT &gt; &amp; _full_evaluation) :
<a name="l00071"></a>00071 <a class="code" href="classmo_h_c.html#ec4e702a6ec240f40ff9d262c36d080b" title="Complete exploration of the neighborhood.">move_explorer</a> ( *new <a class="code" href="classmo_h_c_move_loop_expl.html" title="Iterative explorer used by a moHC.">moHCMoveLoopExpl</a> &lt; M &gt; (_move_initializer, _next_move_generator, _incremental_evaluation, _move_selection) ),
<a name="l00072"></a>00072 <a class="code" href="classmo_h_c.html#1175c588c19d3658cfc690d5f3f8d825" title="A full evaluation function.">full_evaluation</a> (_full_evaluation)
<a name="l00073"></a>00073 {}
<a name="l00074"></a>00074
<a name="l00076"></a>00076
<a name="l00082"></a><a class="code" href="classmo_h_c.html#5002f969ef0a4d959610158fc62f137a">00082</a> <a class="code" href="classmo_h_c.html#44a35bd30df6e79cff95a31b84889bd7" title="Full constructor.">moHC</a> (moMoveExpl &lt; M &gt; &amp; _move_explorer, eoEvalFunc &lt; EOT &gt; &amp; _full_evaluation):
<a name="l00083"></a>00083 <a class="code" href="classmo_h_c.html#ec4e702a6ec240f40ff9d262c36d080b" title="Complete exploration of the neighborhood.">move_explorer</a> (_move_explorer), <a class="code" href="classmo_h_c.html#1175c588c19d3658cfc690d5f3f8d825" title="A full evaluation function.">full_evaluation</a> (_full_evaluation)
<a name="l00084"></a>00084 {}
<a name="l00085"></a>00085
<a name="l00087"></a>00087
<a name="l00094"></a><a class="code" href="classmo_h_c.html#b739f9586b647e32bf31605066f984ad">00094</a> <span class="keywordtype">bool</span> <a class="code" href="classmo_h_c.html#b739f9586b647e32bf31605066f984ad" title="Function which launches the HC.">operator ()</a>(<a class="code" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb" title="Alias for the type.">EOT</a> &amp; _solution)
<a name="l00095"></a>00095 {
<a name="l00096"></a>00096 <a class="code" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb" title="Alias for the type.">EOT</a> new_solution;
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="keywordflow">if</span> ( _solution.invalid() )
<a name="l00099"></a>00099 {
<a name="l00100"></a>00100 <a class="code" href="classmo_h_c.html#1175c588c19d3658cfc690d5f3f8d825" title="A full evaluation function.">full_evaluation</a>(_solution);
<a name="l00101"></a>00101 }
<a name="l00102"></a>00102
<a name="l00103"></a>00103 new_solution=_solution;
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="keywordflow">do</span>
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 _solution=new_solution;
<a name="l00108"></a>00108 <a class="code" href="classmo_h_c.html#ec4e702a6ec240f40ff9d262c36d080b" title="Complete exploration of the neighborhood.">move_explorer</a> (_solution, new_solution);
<a name="l00109"></a>00109 }
<a name="l00110"></a>00110 <span class="keywordflow">while</span> ( new_solution.fitness() &gt; _solution.fitness() );
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keyword">private</span>:
<a name="l00116"></a>00116
<a name="l00118"></a><a class="code" href="classmo_h_c.html#ec4e702a6ec240f40ff9d262c36d080b">00118</a> moMoveExpl &lt; M &gt; &amp; <a class="code" href="classmo_h_c.html#ec4e702a6ec240f40ff9d262c36d080b" title="Complete exploration of the neighborhood.">move_explorer</a>;
<a name="l00119"></a>00119
<a name="l00121"></a><a class="code" href="classmo_h_c.html#1175c588c19d3658cfc690d5f3f8d825">00121</a> eoEvalFunc &lt; EOT &gt; &amp; <a class="code" href="classmo_h_c.html#1175c588c19d3658cfc690d5f3f8d825" title="A full evaluation function.">full_evaluation</a>;
<a name="l00122"></a>00122 };
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Wed Jan 16 15:50:40 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>