paradiseo/trunk/paradiseo-mo/doc/html/classmo_gen_sol_continue.html
jboisson 1d94071693 In the TSP, the fitness has to be minimized ... with all the needed modification (for example, moSA.h)
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@587 331e1502-861f-0410-8da2-ba01fb791d7f
2007-08-03 14:28:06 +00:00

182 lines
10 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: moGenSolContinue&lt; EOT &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>moGenSolContinue&lt; EOT &gt; Class Template Reference</h1><!-- doxytag: class="moGenSolContinue" --><!-- doxytag: inherits="moSolContinue" -->One possible stopping criterion for a solution-based heuristic.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="mo_gen_sol_continue_8h-source.html">moGenSolContinue.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moGenSolContinue&lt; EOT &gt;:
<p><center><img src="classmo_gen_sol_continue.png" usemap="#moGenSolContinue< EOT >_map" border="0" alt=""></center>
<map name="moGenSolContinue< EOT >_map">
<area href="classmo_sol_continue.html" alt="moSolContinue< EOT >" shape="rect" coords="0,112,173,136">
<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< const EOT &, bool >" shape="rect" coords="0,56,173,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,173,24">
</map>
<a href="classmo_gen_sol_continue-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_gen_sol_continue.html#b56e890f1caa3f98e161c6512b59c95b">moGenSolContinue</a> (unsigned int __maxNumGen)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Basic constructor. <a href="#b56e890f1caa3f98e161c6512b59c95b"></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_gen_sol_continue.html#457257cd73b474d6f7783d84d02c2e61">operator()</a> (const EOT &amp;__sol)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function that activates the stop criterion. <a href="#457257cd73b474d6f7783d84d02c2e61"></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_gen_sol_continue.html#6c5db8182157584b56507cc9075602d4">init</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Procedure which allows to initialise all the stuff needed. <a href="#6c5db8182157584b56507cc9075602d4"></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="30b9861e090578bdfa2374806600987a"></a><!-- doxytag: member="moGenSolContinue::maxNumGen" ref="30b9861e090578bdfa2374806600987a" args="" -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_gen_sol_continue.html#30b9861e090578bdfa2374806600987a">maxNumGen</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Iteration maximum number. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="630d9736a3a2c952540cdc211764258c"></a><!-- doxytag: member="moGenSolContinue::numGen" ref="630d9736a3a2c952540cdc211764258c" args="" -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_gen_sol_continue.html#630d9736a3a2c952540cdc211764258c">numGen</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Iteration current number. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class EOT&gt;<br>
class moGenSolContinue&lt; EOT &gt;</h3>
One possible stopping criterion for a solution-based heuristic.
<p>
The stopping criterion corresponds to a maximum number of iteration.
<p>
<p>
Definition at line <a class="el" href="mo_gen_sol_continue_8h-source.html#l00021">21</a> of file <a class="el" href="mo_gen_sol_continue_8h-source.html">moGenSolContinue.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b56e890f1caa3f98e161c6512b59c95b"></a><!-- doxytag: member="moGenSolContinue::moGenSolContinue" ref="b56e890f1caa3f98e161c6512b59c95b" args="(unsigned int __maxNumGen)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EOT&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmo_gen_sol_continue.html">moGenSolContinue</a>&lt; EOT &gt;::<a class="el" href="classmo_gen_sol_continue.html">moGenSolContinue</a> </td>
<td>(</td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>__maxNumGen</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Basic constructor.
<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>__maxNumGen</em>&nbsp;</td><td>the maximum number of generation. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="mo_gen_sol_continue_8h-source.html#l00030">30</a> of file <a class="el" href="mo_gen_sol_continue_8h-source.html">moGenSolContinue.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="457257cd73b474d6f7783d84d02c2e61"></a><!-- doxytag: member="moGenSolContinue::operator()" ref="457257cd73b474d6f7783d84d02c2e61" args="(const EOT &amp;__sol)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EOT&gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmo_gen_sol_continue.html">moGenSolContinue</a>&lt; EOT &gt;::operator() </td>
<td>(</td>
<td class="paramtype">const EOT &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 that activates the stop criterion.
<p>
Increments the counter and returns true if the current number of iteration is lower than the given maximum number of iterations.<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>the current solution. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true or false according to the current generation number. </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; const EOT &amp;, bool &gt;</a>.
<p>
Definition at line <a class="el" href="mo_gen_sol_continue_8h-source.html#l00042">42</a> of file <a class="el" href="mo_gen_sol_continue_8h-source.html">moGenSolContinue.h</a>.
<p>
References <a class="el" href="mo_gen_sol_continue_8h-source.html#l00059">moGenSolContinue&lt; EOT &gt;::maxNumGen</a>, and <a class="el" href="mo_gen_sol_continue_8h-source.html#l00062">moGenSolContinue&lt; EOT &gt;::numGen</a>.
</div>
</div><p>
<a class="anchor" name="6c5db8182157584b56507cc9075602d4"></a><!-- doxytag: member="moGenSolContinue::init" ref="6c5db8182157584b56507cc9075602d4" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EOT&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmo_gen_sol_continue.html">moGenSolContinue</a>&lt; EOT &gt;::init </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Procedure which allows to initialise all the stuff needed.
<p>
It can be also used to reinitialize the counter all the needed things.
<p>
Implements <a class="el" href="classmo_sol_continue.html#064dc966a210f4ffb9515be3f03ca4c7">moSolContinue&lt; EOT &gt;</a>.
<p>
Definition at line <a class="el" href="mo_gen_sol_continue_8h-source.html#l00051">51</a> of file <a class="el" href="mo_gen_sol_continue_8h-source.html">moGenSolContinue.h</a>.
<p>
References <a class="el" href="mo_gen_sol_continue_8h-source.html#l00062">moGenSolContinue&lt; EOT &gt;::numGen</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mo_gen_sol_continue_8h-source.html">moGenSolContinue.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 3 16:25:56 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>