paradiseo/branches/cmakemodif/paradiseo-mo/doc/html/classmo_h_c.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

231 lines
15 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&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>moHC&lt; M &gt; Class Template Reference</h1><!-- doxytag: class="moHC" --><!-- doxytag: inherits="moAlgo&lt; M::EOType &gt;" -->Hill Climbing (HC).
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_h_c_8h-source.html">moHC.h</a>&gt;</code>
<p>
Inherits <a class="el" href="classmo_algo.html">moAlgo&lt; M::EOType &gt;</a>.
<p>
<p>
<a href="classmo_h_c-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_h_c.html#44a35bd30df6e79cff95a31b84889bd7">moHC</a> (<a class="el" href="classmo_move_init.html">moMoveInit</a>&lt; M &gt; &amp;_move_initializer, <a class="el" href="classmo_next_move.html">moNextMove</a>&lt; M &gt; &amp;_next_move_generator, <a class="el" href="classmo_move_incr_eval.html">moMoveIncrEval</a>&lt; M &gt; &amp;_incremental_evaluation, <a class="el" href="classmo_move_select.html">moMoveSelect</a>&lt; M &gt; &amp;_move_selection, <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_h_c.html#d219296ede03c679646bce2fe8ff96cb">EOT</a> &gt; &amp;_full_evaluation)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Full constructor. <a href="#44a35bd30df6e79cff95a31b84889bd7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_h_c.html#5002f969ef0a4d959610158fc62f137a">moHC</a> (<a class="el" href="classmo_move_expl.html">moMoveExpl</a>&lt; M &gt; &amp;_move_explorer, <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_h_c.html#d219296ede03c679646bce2fe8ff96cb">EOT</a> &gt; &amp;_full_evaluation)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Light constructor. <a href="#5002f969ef0a4d959610158fc62f137a"></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_h_c.html#b739f9586b647e32bf31605066f984ad">operator()</a> (<a class="el" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb">EOT</a> &amp;_solution)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="elRef" doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/struct_function.html">Function</a> which launches the HC. <a href="#b739f9586b647e32bf31605066f984ad"></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="d219296ede03c679646bce2fe8ff96cb"></a><!-- doxytag: member="moHC::EOT" ref="d219296ede03c679646bce2fe8ff96cb" args="" -->
typedef M::EOType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb">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="56487c97a7cf0c423cc879d1bbd45027"></a><!-- doxytag: member="moHC::Fitness" ref="56487c97a7cf0c423cc879d1bbd45027" args="" -->
typedef EOT::Fitness&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_h_c.html#56487c97a7cf0c423cc879d1bbd45027">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="ec4e702a6ec240f40ff9d262c36d080b"></a><!-- doxytag: member="moHC::move_explorer" ref="ec4e702a6ec240f40ff9d262c36d080b" args="" -->
<a class="el" href="classmo_move_expl.html">moMoveExpl</a>&lt; M &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_h_c.html#ec4e702a6ec240f40ff9d262c36d080b">move_explorer</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Complete exploration of the neighborhood. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1175c588c19d3658cfc690d5f3f8d825"></a><!-- doxytag: member="moHC::full_evaluation" ref="1175c588c19d3658cfc690d5f3f8d825" 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_h_c.html#d219296ede03c679646bce2fe8ff96cb">EOT</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_h_c.html#1175c588c19d3658cfc690d5f3f8d825">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 moHC&lt; M &gt;</h3>
Hill Climbing (HC).
<p>
Class which describes the algorithm for a hill climbing.
<p>Definition at line <a class="el" href="mo_h_c_8h-source.html#l00049">49</a> of file <a class="el" href="mo_h_c_8h-source.html">moHC.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="44a35bd30df6e79cff95a31b84889bd7"></a><!-- doxytag: member="moHC::moHC" ref="44a35bd30df6e79cff95a31b84889bd7" args="(moMoveInit&lt; M &gt; &amp;_move_initializer, moNextMove&lt; M &gt; &amp;_next_move_generator, moMoveIncrEval&lt; M &gt; &amp;_incremental_evaluation, moMoveSelect&lt; M &gt; &amp;_move_selection, 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_h_c.html">moHC</a>&lt; M &gt;::<a class="el" href="classmo_h_c.html">moHC</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmo_move_init.html">moMoveInit</a>&lt; M &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_move_initializer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmo_next_move.html">moNextMove</a>&lt; M &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_next_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_move_select.html">moMoveSelect</a>&lt; M &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_move_selection</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_h_c.html#d219296ede03c679646bce2fe8ff96cb">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>
Full constructor.
<p>
All the boxes are given in order the HC to use a <a class="el" href="classmo_h_c_move_loop_expl.html" title="Iterative explorer used by a moHC.">moHCMoveLoopExpl</a>.<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_initializer</em>&nbsp;</td><td>a move initialiser. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_next_move_generator</em>&nbsp;</td><td>a neighborhood explorer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_incremental_evaluation</em>&nbsp;</td><td>a (generally) efficient evaluation function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_move_selection</em>&nbsp;</td><td>a move selector. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_full_evaluation</em>&nbsp;</td><td>a full evaluation function. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="mo_h_c_8h-source.html#l00069">69</a> of file <a class="el" href="mo_h_c_8h-source.html">moHC.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5002f969ef0a4d959610158fc62f137a"></a><!-- doxytag: member="moHC::moHC" ref="5002f969ef0a4d959610158fc62f137a" args="(moMoveExpl&lt; M &gt; &amp;_move_explorer, 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_h_c.html">moHC</a>&lt; M &gt;::<a class="el" href="classmo_h_c.html">moHC</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmo_move_expl.html">moMoveExpl</a>&lt; M &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_move_explorer</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_h_c.html#d219296ede03c679646bce2fe8ff96cb">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>
Light constructor.
<p>
This constructor allow to use another <a class="el" href="classmo_move_expl.html" title="Description of a move (moMove) explorer.">moMoveExpl</a> (generally not a <a class="el" href="classmo_h_c_move_loop_expl.html" title="Iterative explorer used by a moHC.">moHCMoveLoopExpl</a>).<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_explorer</em>&nbsp;</td><td>a complete explorer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_full_evaluation</em>&nbsp;</td><td>a full evaluation function. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="mo_h_c_8h-source.html#l00082">82</a> of file <a class="el" href="mo_h_c_8h-source.html">moHC.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b739f9586b647e32bf31605066f984ad"></a><!-- doxytag: member="moHC::operator()" ref="b739f9586b647e32bf31605066f984ad" 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_h_c.html">moHC</a>&lt; M &gt;::operator() </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb">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>
<a class="elRef" doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/struct_function.html">Function</a> which launches the HC.
<p>
The HC has to improve a current solution. As the <a class="el" href="classmo_s_a.html" title="Simulated Annealing (SA).">moSA</a> and the mo TS, it can be used for HYBRIDATION in an evolutionnary 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 current 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_h_c_8h-source.html#l00094">94</a> of file <a class="el" href="mo_h_c_8h-source.html">moHC.h</a>.</p>
<p>References <a class="el" href="mo_h_c_8h-source.html#l00121">moHC&lt; M &gt;::full_evaluation</a>, and <a class="el" href="mo_h_c_8h-source.html#l00118">moHC&lt; M &gt;::move_explorer</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mo_h_c_8h-source.html">moHC.h</a></ul>
<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>