paradiseo/trunk/paradiseo-mo/doc/html/classmo_t_s.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

263 lines
18 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-MO: moTS&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>moTS&lt; M &gt; Class Template Reference</h1><!-- doxytag: class="moTS" --><!-- doxytag: inherits="moAlgo&lt; M::EOType &gt;" -->Tabu Search (TS).
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_t_s_8h-source.html">moTS.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moTS&lt; M &gt;:
<p><center><img src="classmo_t_s.png" usemap="#moTS< M >_map" border="0" alt=""></center>
<map name="moTS< 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_t_s-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_t_s.html#2be23f4524733ee6f37b71310d76407e">moTS</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_tabu_list.html">moTabuList</a>&lt; M &gt; &amp;__tabu_list, <a class="el" href="classmo_aspir_crit.html">moAspirCrit</a>&lt; M &gt; &amp;__aspir_crit, <a class="el" href="classmo_sol_continue.html">moSolContinue</a>&lt; <a class="el" href="classmo_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">EOT</a> &gt; &amp;__cont, <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_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">EOT</a> &gt; &amp;__full_eval)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor of a <a class="el" href="classmo_t_s.html" title="Tabu Search (TS).">moTS</a> specifying all the boxes. <a href="#2be23f4524733ee6f37b71310d76407e"></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_t_s.html#508e675c4232cf2ca06dded931c90bab">moTS</a> (<a class="el" href="classmo_move_expl.html">moMoveExpl</a>&lt; M &gt; &amp;__move_expl, <a class="el" href="classmo_sol_continue.html">moSolContinue</a>&lt; <a class="el" href="classmo_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">EOT</a> &gt; &amp;__cont, <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_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">EOT</a> &gt; &amp;__full_eval)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with less parameters. <a href="#508e675c4232cf2ca06dded931c90bab"></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_t_s.html#94d25a76fe1bc9ef0bbd0358ff55aceb">operator()</a> (<a class="el" href="classmo_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">EOT</a> &amp;__sol)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function which launchs the Tabu Search. <a href="#94d25a76fe1bc9ef0bbd0358ff55aceb"></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="90d19d468c12ab5bd796948ce1ce79b1"></a><!-- doxytag: member="moTS::EOT" ref="90d19d468c12ab5bd796948ce1ce79b1" args="" -->
typedef M::EOType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">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="aa0eefbb17111422e495d1255f876fca"></a><!-- doxytag: member="moTS::Fitness" ref="aa0eefbb17111422e495d1255f876fca" args="" -->
typedef EOT::Fitness&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_t_s.html#aa0eefbb17111422e495d1255f876fca">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="06914ddc90ca96e9158c8dbe182a7865"></a><!-- doxytag: member="moTS::move_expl" ref="06914ddc90ca96e9158c8dbe182a7865" 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_t_s.html#06914ddc90ca96e9158c8dbe182a7865">move_expl</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Neighborhood explorer. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="969371cd2202f3d29cbb426f57ac7d3a"></a><!-- doxytag: member="moTS::cont" ref="969371cd2202f3d29cbb426f57ac7d3a" args="" -->
<a class="el" href="classmo_sol_continue.html">moSolContinue</a>&lt; <a class="el" href="classmo_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">EOT</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_t_s.html#969371cd2202f3d29cbb426f57ac7d3a">cont</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop criterion. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb67eddae5d0bfca4ed881995523231e"></a><!-- doxytag: member="moTS::full_eval" ref="fb67eddae5d0bfca4ed881995523231e" 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_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">EOT</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_t_s.html#fb67eddae5d0bfca4ed881995523231e">full_eval</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Full evaluation function. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class M&gt;<br>
class moTS&lt; M &gt;</h3>
Tabu Search (TS).
<p>
Generic algorithm that describes a tabu search.
<p>
<p>
Definition at line <a class="el" href="mo_t_s_8h-source.html#l00029">29</a> of file <a class="el" href="mo_t_s_8h-source.html">moTS.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="2be23f4524733ee6f37b71310d76407e"></a><!-- doxytag: member="moTS::moTS" ref="2be23f4524733ee6f37b71310d76407e" args="(moMoveInit&lt; M &gt; &amp;__move_init, moNextMove&lt; M &gt; &amp;__next_move, moMoveIncrEval&lt; M &gt; &amp;__incr_eval, moTabuList&lt; M &gt; &amp;__tabu_list, moAspirCrit&lt; M &gt; &amp;__aspir_crit, moSolContinue&lt; EOT &gt; &amp;__cont, 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_t_s.html">moTS</a>&lt; M &gt;::<a class="el" href="classmo_t_s.html">moTS</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_tabu_list.html">moTabuList</a>&lt; M &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>__tabu_list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmo_aspir_crit.html">moAspirCrit</a>&lt; M &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>__aspir_crit</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_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">EOT</a> &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>__cont</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_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">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>
Constructor of a <a class="el" href="classmo_t_s.html" title="Tabu Search (TS).">moTS</a> specifying all the boxes.
<p>
In this constructor, a <a class="el" href="classmo_t_s_move_loop_expl.html" title="Explorer for a Tabu Search algorithm.">moTSMoveLoopExpl</a> is instanciated.<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>move initialisation </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__next_move</em>&nbsp;</td><td>neighborhood explorer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__incr_eval</em>&nbsp;</td><td>efficient evaluation </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__tabu_list</em>&nbsp;</td><td>tabu list </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__aspir_crit</em>&nbsp;</td><td>aspiration criterion </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__cont</em>&nbsp;</td><td>stop criterion </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__full_eval</em>&nbsp;</td><td>full evaluation function </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="mo_t_s_8h-source.html#l00058">58</a> of file <a class="el" href="mo_t_s_8h-source.html">moTS.h</a>.
</div>
</div><p>
<a class="anchor" name="508e675c4232cf2ca06dded931c90bab"></a><!-- doxytag: member="moTS::moTS" ref="508e675c4232cf2ca06dded931c90bab" args="(moMoveExpl&lt; M &gt; &amp;__move_expl, moSolContinue&lt; EOT &gt; &amp;__cont, 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_t_s.html">moTS</a>&lt; M &gt;::<a class="el" href="classmo_t_s.html">moTS</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"><a class="el" href="classmo_sol_continue.html">moSolContinue</a>&lt; <a class="el" href="classmo_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">EOT</a> &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>__cont</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_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">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>
Constructor with less parameters.
<p>
The explorer is given in the parameters.<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>the explorer (generally different that a <a class="el" href="classmo_t_s_move_loop_expl.html" title="Explorer for a Tabu Search algorithm.">moTSMoveLoopExpl</a>) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__cont</em>&nbsp;</td><td>stop criterion </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__full_eval</em>&nbsp;</td><td>full evaluation function </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="mo_t_s_8h-source.html#l00071">71</a> of file <a class="el" href="mo_t_s_8h-source.html">moTS.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="94d25a76fe1bc9ef0bbd0358ff55aceb"></a><!-- doxytag: member="moTS::operator()" ref="94d25a76fe1bc9ef0bbd0358ff55aceb" 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_t_s.html">moTS</a>&lt; M &gt;::operator() </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmo_t_s.html#90d19d468c12ab5bd796948ce1ce79b1">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 which launchs the Tabu Search.
<p>
Algorithm of the tabu search. As a <a class="el" href="classmo_s_a.html" title="Simulated Annealing (SA).">moSA</a> or a <a class="el" href="classmo_h_c.html" title="Hill Climbing (HC).">moHC</a>, it can be used for HYBRIDATION in an evolutionary algorithm. For security a lock (pthread_mutex_t) is closed during the 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_t_s_8h-source.html#l00085">85</a> of file <a class="el" href="mo_t_s_8h-source.html">moTS.h</a>.
<p>
References <a class="el" href="mo_t_s_8h-source.html#l00137">moTS&lt; M &gt;::cont</a>, <a class="el" href="mo_t_s_8h-source.html#l00140">moTS&lt; M &gt;::full_eval</a>, and <a class="el" href="mo_t_s_8h-source.html#l00134">moTS&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_t_s_8h-source.html">moTS.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>