nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/paradiseo-mo/doc/html/classmo_move_select.html
jboisson 6f2c04931b New docs are included 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@882 331e1502-861f-0410-8da2-ba01fb791d7f
2008-01-15 16:06:58 +00:00

157 lines
9.6 KiB
HTML
Raw Blame History

<!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: moMoveSelect&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>moMoveSelect&lt; M &gt; Class Template Reference</h1><!-- doxytag: class="moMoveSelect" --><!-- doxytag: inherits="eoBF&lt; M &amp;, M::EOType::Fitness &amp;, void &gt;" -->Class that describes a move selector (<a class="el" href="classmo_move.html" title="Definition of a move.">moMove</a>).
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_move_select_8h-source.html">moMoveSelect.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for moMoveSelect&lt; M &gt;:</div>
<div class="dynsection">
<p><center><img src="classmo_move_select.png" usemap="#moMoveSelect< M >_map" border="0" alt=""></center>
<map name="moMoveSelect< M >_map">
<area doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_b_f.html" alt="eoBF< M &, M::EOType::Fitness &, void >" shape="rect" coords="266,56,522,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="266,0,522,24">
<area href="classmo_best_impr_select.html" alt="moBestImprSelect< M >" shape="rect" coords="0,168,256,192">
<area href="classmo_first_impr_select.html" alt="moFirstImprSelect< M >" shape="rect" coords="266,168,522,192">
<area href="classmo_rand_impr_select.html" alt="moRandImprSelect< M >" shape="rect" coords="532,168,788,192">
</map>
</div>
<p>
<a href="classmo_move_select-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="8148ccc0e6fbd209c3fe6829559895c8"></a><!-- doxytag: member="moMoveSelect::Fitness" ref="8148ccc0e6fbd209c3fe6829559895c8" args="" -->
typedef M::EOType::Fitness&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_move_select.html#8148ccc0e6fbd209c3fe6829559895c8">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>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_move_select.html#58038bd859632c1bd022d23d9792bdca">init</a> (const <a class="el" href="classmo_move_select.html#8148ccc0e6fbd209c3fe6829559895c8">Fitness</a> &amp;_fitness)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Procedure which initialises all that the move selector needs including the initial fitness. <a href="#58038bd859632c1bd022d23d9792bdca"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_move_select.html#5b4d3b2f030cca80c563c3db0c4af404">update</a> (const M &amp;_move, const <a class="el" href="classmo_move_select.html#8148ccc0e6fbd209c3fe6829559895c8">Fitness</a> &amp;_fitness)=0</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 updates the best solutions. <a href="#5b4d3b2f030cca80c563c3db0c4af404"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class M&gt;<br>
class moMoveSelect&lt; M &gt;</h3>
Class that describes a move selector (<a class="el" href="classmo_move.html" title="Definition of a move.">moMove</a>).
<p>
It iteratively considers some moves (<a class="el" href="classmo_move.html" title="Definition of a move.">moMove</a>) and their associated fitnesses. The best move is so regularly updated. At any time, it could be accessed.
<p>Definition at line <a class="el" href="mo_move_select_8h-source.html#l00050">50</a> of file <a class="el" href="mo_move_select_8h-source.html">moMoveSelect.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="58038bd859632c1bd022d23d9792bdca"></a><!-- doxytag: member="moMoveSelect::init" ref="58038bd859632c1bd022d23d9792bdca" args="(const Fitness &amp;_fitness)=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_move_select.html">moMoveSelect</a>&lt; M &gt;::init </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmo_move_select.html#8148ccc0e6fbd209c3fe6829559895c8">Fitness</a> &amp;&nbsp;</td>
<td class="paramname"> <em>_fitness</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Procedure which initialises all that the move selector needs including the initial fitness.
<p>
In order to know the fitness of the solution, for which the neighborhood will be soon explored<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>_fitness</em>&nbsp;</td><td>the current fitness. </td></tr>
</table>
</dl>
<p>Implemented in <a class="el" href="classmo_best_impr_select.html#83f961549986b8ad94692e433aa79114">moBestImprSelect&lt; M &gt;</a>, <a class="el" href="classmo_first_impr_select.html#a923437ecc3db50e7052b002a9a1bbf8">moFirstImprSelect&lt; M &gt;</a>, and <a class="el" href="classmo_rand_impr_select.html#7af99966b31aa387ecef74fd307a42e8">moRandImprSelect&lt; M &gt;</a>.</p>
</div>
</div><p>
<a class="anchor" name="5b4d3b2f030cca80c563c3db0c4af404"></a><!-- doxytag: member="moMoveSelect::update" ref="5b4d3b2f030cca80c563c3db0c4af404" args="(const M &amp;_move, const Fitness &amp;_fitness)=0" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class M&gt; </div>
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="classmo_move_select.html">moMoveSelect</a>&lt; M &gt;::update </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_move_select.html#8148ccc0e6fbd209c3fe6829559895c8">Fitness</a> &amp;&nbsp;</td>
<td class="paramname"> <em>_fitness</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>
<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 updates the best solutions.
<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 move. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_fitness</em>&nbsp;</td><td>a fitness linked to the new move. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a boolean that expresses the need to resume the exploration. </dd></dl>
<p>Implemented in <a class="el" href="classmo_best_impr_select.html#5c0729fd316b0ef78406bce5ca91de2a">moBestImprSelect&lt; M &gt;</a>, <a class="el" href="classmo_first_impr_select.html#f68b7ee7b35bf7347c16006f0587d313">moFirstImprSelect&lt; M &gt;</a>, and <a class="el" href="classmo_rand_impr_select.html#b20cfd0164266aa75960cba3c1673f69">moRandImprSelect&lt; M &gt;</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mo_move_select_8h-source.html">moMoveSelect.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 15 17:04:26 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>
Reference in a new issue View git blame Copy permalink