nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/paradiseo-mo/doc/html/classmo_first_impr_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

228 lines
15 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: moFirstImprSelect&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>moFirstImprSelect&lt; M &gt; Class Template Reference</h1><!-- doxytag: class="moFirstImprSelect" --><!-- doxytag: inherits="moMoveSelect" -->One possible <a class="el" href="classmo_move_select.html" title="Class that describes a move selector (moMove).">moMoveSelect</a>.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_first_impr_select_8h-source.html">moFirstImprSelect.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for moFirstImprSelect&lt; M &gt;:</div>
<div class="dynsection">
<p><center><img src="classmo_first_impr_select.png" usemap="#moFirstImprSelect< M >_map" border="0" alt=""></center>
<map name="moFirstImprSelect< M >_map">
<area href="classmo_move_select.html" alt="moMoveSelect< M >" shape="rect" coords="0,112,256,136">
<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="0,56,256,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="0,0,256,24">
</map>
</div>
<p>
<a href="classmo_first_impr_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="64763ce3e6d2873266624382b407fa5a"></a><!-- doxytag: member="moFirstImprSelect::Fitness" ref="64763ce3e6d2873266624382b407fa5a" args="" -->
typedef M::EOType::Fitness&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_first_impr_select.html#64763ce3e6d2873266624382b407fa5a">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_first_impr_select.html#a923437ecc3db50e7052b002a9a1bbf8">init</a> (const <a class="el" href="classmo_first_impr_select.html#64763ce3e6d2873266624382b407fa5a">Fitness</a> &amp;_fitness)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Procedure which initialise the exploration. <a href="#a923437ecc3db50e7052b002a9a1bbf8"></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_first_impr_select.html#f68b7ee7b35bf7347c16006f0587d313">update</a> (const M &amp;_move, const <a class="el" href="classmo_first_impr_select.html#64763ce3e6d2873266624382b407fa5a">Fitness</a> &amp;_fitness)</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> that indicates if the current move has not improved the fitness. <a href="#f68b7ee7b35bf7347c16006f0587d313"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_first_impr_select.html#976569efd882886cb13184daeba79766">operator()</a> (M &amp;_move, <a class="el" href="classmo_first_impr_select.html#64763ce3e6d2873266624382b407fa5a">Fitness</a> &amp;_fitness)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Procedure which saved the best move and fitness. <a href="#976569efd882886cb13184daeba79766"></a><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="a99c0586ba07449234705c17a258d58c"></a><!-- doxytag: member="moFirstImprSelect::valid" ref="a99c0586ba07449234705c17a258d58c" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_first_impr_select.html#a99c0586ba07449234705c17a258d58c">valid</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allow to know if at least one move has improved the solution. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dfed419a608dd7c41f07fa1f1279cb8c"></a><!-- doxytag: member="moFirstImprSelect::best_move" ref="dfed419a608dd7c41f07fa1f1279cb8c" args="" -->
M&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_first_impr_select.html#dfed419a608dd7c41f07fa1f1279cb8c">best_move</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Best stored movement. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="669f8f2f74e71bf2b7fdabfc9cca2c0e"></a><!-- doxytag: member="moFirstImprSelect::initial_fitness" ref="669f8f2f74e71bf2b7fdabfc9cca2c0e" args="" -->
<a class="el" href="classmo_first_impr_select.html#64763ce3e6d2873266624382b407fa5a">Fitness</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_first_impr_select.html#669f8f2f74e71bf2b7fdabfc9cca2c0e">initial_fitness</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initial fitness. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="287937f5c059b078ccec94e86e0a8238"></a><!-- doxytag: member="moFirstImprSelect::best_fitness" ref="287937f5c059b078ccec94e86e0a8238" args="" -->
<a class="el" href="classmo_first_impr_select.html#64763ce3e6d2873266624382b407fa5a">Fitness</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_first_impr_select.html#287937f5c059b078ccec94e86e0a8238">best_fitness</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Best stored fitness. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class M&gt;<br>
class moFirstImprSelect&lt; M &gt;</h3>
One possible <a class="el" href="classmo_move_select.html" title="Class that describes a move selector (moMove).">moMoveSelect</a>.
<p>
The neighborhood is explored until a move enables an improvment of the current solution.
<p>Definition at line <a class="el" href="mo_first_impr_select_8h-source.html#l00048">48</a> of file <a class="el" href="mo_first_impr_select_8h-source.html">moFirstImprSelect.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a923437ecc3db50e7052b002a9a1bbf8"></a><!-- doxytag: member="moFirstImprSelect::init" ref="a923437ecc3db50e7052b002a9a1bbf8" args="(const Fitness &amp;_fitness)" -->
<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_first_impr_select.html">moFirstImprSelect</a>&lt; M &gt;::init </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmo_first_impr_select.html#64763ce3e6d2873266624382b407fa5a">Fitness</a> &amp;&nbsp;</td>
<td class="paramname"> <em>_fitness</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Procedure which initialise the exploration.
<p>
It save the current fitness as the initial value for the fitness. <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>Implements <a class="el" href="classmo_move_select.html#58038bd859632c1bd022d23d9792bdca">moMoveSelect&lt; M &gt;</a>.</p>
<p>Definition at line <a class="el" href="mo_first_impr_select_8h-source.html#l00060">60</a> of file <a class="el" href="mo_first_impr_select_8h-source.html">moFirstImprSelect.h</a>.</p>
<p>References <a class="el" href="mo_first_impr_select_8h-source.html#l00114">moFirstImprSelect&lt; M &gt;::initial_fitness</a>, and <a class="el" href="mo_first_impr_select_8h-source.html#l00108">moFirstImprSelect&lt; M &gt;::valid</a>.</p>
</div>
</div><p>
<a class="anchor" name="f68b7ee7b35bf7347c16006f0587d313"></a><!-- doxytag: member="moFirstImprSelect::update" ref="f68b7ee7b35bf7347c16006f0587d313" args="(const M &amp;_move, const Fitness &amp;_fitness)" -->
<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_first_impr_select.html">moFirstImprSelect</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_first_impr_select.html#64763ce3e6d2873266624382b407fa5a">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> [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> that indicates if the current move has not improved the fitness.
<p>
If the given fitness enables an improvment, the move (<a class="el" href="classmo_move.html" title="Definition of a move.">moMove</a>) should be applied to the current solution.<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 move. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_fitness</em>&nbsp;</td><td>a fitness linked to the move. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the move does not improve the fitness. </dd></dl>
<p>Implements <a class="el" href="classmo_move_select.html#5b4d3b2f030cca80c563c3db0c4af404">moMoveSelect&lt; M &gt;</a>.</p>
<p>Definition at line <a class="el" href="mo_first_impr_select_8h-source.html#l00075">75</a> of file <a class="el" href="mo_first_impr_select_8h-source.html">moFirstImprSelect.h</a>.</p>
<p>References <a class="el" href="mo_first_impr_select_8h-source.html#l00117">moFirstImprSelect&lt; M &gt;::best_fitness</a>, <a class="el" href="mo_first_impr_select_8h-source.html#l00111">moFirstImprSelect&lt; M &gt;::best_move</a>, <a class="el" href="mo_first_impr_select_8h-source.html#l00114">moFirstImprSelect&lt; M &gt;::initial_fitness</a>, and <a class="el" href="mo_first_impr_select_8h-source.html#l00108">moFirstImprSelect&lt; M &gt;::valid</a>.</p>
</div>
</div><p>
<a class="anchor" name="976569efd882886cb13184daeba79766"></a><!-- doxytag: member="moFirstImprSelect::operator()" ref="976569efd882886cb13184daeba79766" args="(M &amp;_move, Fitness &amp;_fitness)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class M&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmo_first_impr_select.html">moFirstImprSelect</a>&lt; M &gt;::operator() </td>
<td>(</td>
<td class="paramtype">M &amp;&nbsp;</td>
<td class="paramname"> <em>_move</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmo_first_impr_select.html#64763ce3e6d2873266624382b407fa5a">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> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Procedure which saved the best move and fitness.
<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>the current move (result of the procedure). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_fitness</em>&nbsp;</td><td>the current fitness (result of the procedure). </td></tr>
</table>
</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_b_f.html#a03c40b95210569b826df79a2237a0d0">eoBF&lt; M &amp;, M::EOType::Fitness &amp;, void &gt;</a>.</p>
<p>Definition at line <a class="el" href="mo_first_impr_select_8h-source.html#l00096">96</a> of file <a class="el" href="mo_first_impr_select_8h-source.html">moFirstImprSelect.h</a>.</p>
<p>References <a class="el" href="mo_first_impr_select_8h-source.html#l00117">moFirstImprSelect&lt; M &gt;::best_fitness</a>, <a class="el" href="mo_first_impr_select_8h-source.html#l00111">moFirstImprSelect&lt; M &gt;::best_move</a>, and <a class="el" href="mo_first_impr_select_8h-source.html#l00108">moFirstImprSelect&lt; M &gt;::valid</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mo_first_impr_select_8h-source.html">moFirstImprSelect.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