paradiseo/trunk/docs/html/classmo_tabu_list.html

157 lines
7.7 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: moTabuList&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>moTabuList&lt; M &gt; Class Template Reference</h1><!-- doxytag: class="moTabuList" -->Class describing a tabu list that a <a class="el" href="classmo_t_s.html">moTS</a> uses.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_tabu_list_8h-source.html">moTabuList.h</a>&gt;</code>
<p>
<a href="classmo_tabu_list-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e219715cc3fdd5626764bc50ce6357df"></a><!-- doxytag: member="moTabuList::EOT" ref="e219715cc3fdd5626764bc50ce6357df" args="" -->
typedef M::EOType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_tabu_list.html#e219715cc3fdd5626764bc50ce6357df">EOT</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alias for the type. <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_tabu_list.html#d279d72cb486d812da1ad3d24a69c286">add</a> (const M &amp;__move, const <a class="el" href="classmo_tabu_list.html#e219715cc3fdd5626764bc50ce6357df">EOT</a> &amp;__sol)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Procedure to add a move in the tabu list. <a href="#d279d72cb486d812da1ad3d24a69c286"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_tabu_list.html#a2e5d1132f064093c8ed57046405f5ca">update</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Procedure that updates the tabu list content. <a href="#a2e5d1132f064093c8ed57046405f5ca"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_tabu_list.html#0a06c459d56e8e2b408a8f3c6aec4e57">init</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Procedure which initialises the tabu list. <a href="#0a06c459d56e8e2b408a8f3c6aec4e57"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class M&gt;<br>
class moTabuList&lt; M &gt;</h3>
Class describing a tabu list that a <a class="el" href="classmo_t_s.html">moTS</a> uses.
<p>
It is only a description, does nothing... A new object that herits from this class has to be defined in order to be used in a <a class="el" href="classmo_t_s.html">moTS</a>.
<p>
<p>
Definition at line <a class="el" href="mo_tabu_list_8h-source.html#l00022">22</a> of file <a class="el" href="mo_tabu_list_8h-source.html">moTabuList.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d279d72cb486d812da1ad3d24a69c286"></a><!-- doxytag: member="moTabuList::add" ref="d279d72cb486d812da1ad3d24a69c286" args="(const M &amp;__move, const EOT &amp;__sol)=0" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class M&gt; </div>
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classmo_tabu_list.html">moTabuList</a>&lt; M &gt;::add </td>
<td>(</td>
<td class="paramtype">const M &amp;&nbsp;</td>
<td class="paramname"> <em>__move</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classmo_tabu_list.html#e219715cc3fdd5626764bc50ce6357df">EOT</a> &amp;&nbsp;</td>
<td class="paramname"> <em>__sol</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Procedure to add a move in the tabu list.
<p>
The two parameters have not to be modified so they are constant 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</em>&nbsp;</td><td>a new tabu move </td></tr>
<tr><td valign="top"></td><td valign="top"><em>__sol</em>&nbsp;</td><td>the solution associated to this move </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a2e5d1132f064093c8ed57046405f5ca"></a><!-- doxytag: member="moTabuList::update" ref="a2e5d1132f064093c8ed57046405f5ca" args="()=0" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class M&gt; </div>
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classmo_tabu_list.html">moTabuList</a>&lt; M &gt;::update </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Procedure that updates the tabu list content.
<p>
Generally, a counter associated to each saved move is decreased by one.
</div>
</div><p>
<a class="anchor" name="0a06c459d56e8e2b408a8f3c6aec4e57"></a><!-- doxytag: member="moTabuList::init" ref="0a06c459d56e8e2b408a8f3c6aec4e57" args="()=0" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class M&gt; </div>
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classmo_tabu_list.html">moTabuList</a>&lt; M &gt;::init </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Procedure which initialises the tabu list.
<p>
Can be useful if the data structure needs to be allocated before being used.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mo_tabu_list_8h-source.html">moTabuList.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 12 14:28:37 2006 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>