paradiseo/trunk/paradiseo-mo/docs/html/classmo_h_c.html
jboisson a40fc756aa moSimple(Move/Solution)TabuList are added
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@281 331e1502-861f-0410-8da2-ba01fb791d7f
2007-04-19 13:23:06 +00:00

230 lines
13 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>PARADISEO-MO: 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.1 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li id="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>
<p>Inheritance diagram for moHC&lt; M &gt;:
<p><center><img src="classmo_h_c.png" usemap="#moHC< M >_map" border="0" alt=""></center>
<map name="moHC< M >_map">
<area href="classmo_algo.html" alt="moAlgo< M::EOType >" shape="rect" coords="0,0,141,24">
</map>
<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#6cafe093f86a80c225827884cb9dc5b7">moHC</a> (<a class="el" href="classmo_move_init.html">moMoveInit</a>&lt; M &gt; &amp;__move_init, <a class="el" href="classmo_next_move.html">moNextMove</a>&lt; M &gt; &amp;__next_move, <a class="el" href="classmo_move_incr_eval.html">moMoveIncrEval</a>&lt; M &gt; &amp;__incr_eval, <a class="el" href="classmo_move_select.html">moMoveSelect</a>&lt; M &gt; &amp;__move_select, eoEvalFunc&lt; <a class="el" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb">EOT</a> &gt; &amp;__full_eval)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Full constructor. <a href="#6cafe093f86a80c225827884cb9dc5b7"></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#45f27309792e584a27fa6dcb86ccda65">moHC</a> (<a class="el" href="classmo_move_expl.html">moMoveExpl</a>&lt; M &gt; &amp;__move_expl, eoEvalFunc&lt; <a class="el" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb">EOT</a> &gt; &amp;__full_eval)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Light constructor. <a href="#45f27309792e584a27fa6dcb86ccda65"></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#ed4e273c420efa6386c5975a696a5010">operator()</a> (<a class="el" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb">EOT</a> &amp;__sol)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function which launches the HC. <a href="#ed4e273c420efa6386c5975a696a5010"></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="f6bfb4553fb699f1e08f7d9c37d06103"></a><!-- doxytag: member="moHC::move_expl" ref="f6bfb4553fb699f1e08f7d9c37d06103" 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#f6bfb4553fb699f1e08f7d9c37d06103">move_expl</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="4b0d5cc70fc3d83f59a48b2bdea65736"></a><!-- doxytag: member="moHC::full_eval" ref="4b0d5cc70fc3d83f59a48b2bdea65736" args="" -->
eoEvalFunc&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#4b0d5cc70fc3d83f59a48b2bdea65736">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 moHC&lt; M &gt;</h3>
Hill Climbing (HC).
<p>
Class which describes the algorithm for a hill climbing.
<p>
<p>
Definition at line <a class="el" href="mo_h_c_8h-source.html#l00026">26</a> of file <a class="el" href="mo_h_c_8h-source.html">moHC.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="6cafe093f86a80c225827884cb9dc5b7"></a><!-- doxytag: member="moHC::moHC" ref="6cafe093f86a80c225827884cb9dc5b7" args="(moMoveInit&lt; M &gt; &amp;__move_init, moNextMove&lt; M &gt; &amp;__next_move, moMoveIncrEval&lt; M &gt; &amp;__incr_eval, moMoveSelect&lt; M &gt; &amp;__move_select, 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_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_init</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</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_move_select.html">moMoveSelect</a>&lt; M &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>__move_select</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">eoEvalFunc&lt; <a class="el" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb">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>
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">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_init</em>&nbsp;</td><td>a move initialiser. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__next_move</em>&nbsp;</td><td>a neighborhood explorer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__incr_eval</em>&nbsp;</td><td>a (generally) efficient evaluation function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__move_select</em>&nbsp;</td><td>a move selector. </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_h_c_8h-source.html#l00053">53</a> of file <a class="el" href="mo_h_c_8h-source.html">moHC.h</a>.
</div>
</div><p>
<a class="anchor" name="45f27309792e584a27fa6dcb86ccda65"></a><!-- doxytag: member="moHC::moHC" ref="45f27309792e584a27fa6dcb86ccda65" args="(moMoveExpl&lt; M &gt; &amp;__move_expl, 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_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_expl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">eoEvalFunc&lt; <a class="el" href="classmo_h_c.html#d219296ede03c679646bce2fe8ff96cb">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>
Light constructor.
<p>
This constructor allow to use another <a class="el" href="classmo_move_expl.html">moMoveExpl</a> (generally not a <a class="el" href="classmo_h_c_move_loop_expl.html">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_expl</em>&nbsp;</td><td>a complete explorer. </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_h_c_8h-source.html#l00067">67</a> of file <a class="el" href="mo_h_c_8h-source.html">moHC.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ed4e273c420efa6386c5975a696a5010"></a><!-- doxytag: member="moHC::operator()" ref="ed4e273c420efa6386c5975a696a5010" 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_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>__sol</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function which launches the HC.
<p>
The HC has to improve a current solution. As the <a class="el" href="classmo_s_a.html">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>__sol</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>
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>
References <a class="el" href="mo_h_c_8h-source.html#l00130">moHC&lt; M &gt;::full_eval</a>, and <a class="el" href="mo_h_c_8h-source.html#l00127">moHC&lt; M &gt;::move_expl</a>.
</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="align: right;"><small>Generated on Thu Apr 19 15:16:09 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.1 </small></address>
</body>
</html>