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

186 lines
11 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: 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.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>moGenSolContinue&lt; EOT &gt; Class Template Reference</h1><!-- doxytag: class="moGenSolContinue" --><!-- doxytag: inherits="moSolContinue" -->One possible stop 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>
<div class="dynheader">
Inheritance diagram for moGenSolContinue&lt; EOT &gt;:</div>
<div class="dynsection">
<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>
</div>
<p>
<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#8e2456421b641d38e3f800f3bbe45159">moGenSolContinue</a> (unsigned int _generationMaximumNumber)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Simple constructor. <a href="#8e2456421b641d38e3f800f3bbe45159"></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#2fd5f2f10b6d6208412582578fad48ea">operator()</a> (const EOT &amp;_solution)</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 activates the stop criterion. <a href="#2fd5f2f10b6d6208412582578fad48ea"></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 the generation counter. <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="c838d923436b71c584891c1cbe3f47ba"></a><!-- doxytag: member="moGenSolContinue::generationMaximumNumber" ref="c838d923436b71c584891c1cbe3f47ba" args="" -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_gen_sol_continue.html#c838d923436b71c584891c1cbe3f47ba">generationMaximumNumber</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="af0b3e5ca3ceee0d843670955c8f1e58"></a><!-- doxytag: member="moGenSolContinue::generationNumber" ref="af0b3e5ca3ceee0d843670955c8f1e58" args="" -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_gen_sol_continue.html#af0b3e5ca3ceee0d843670955c8f1e58">generationNumber</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 stop criterion for a solution-based heuristic.
<p>
The stop criterion corresponds to a maximum number of iteration.
<p>Definition at line <a class="el" href="mo_gen_sol_continue_8h-source.html#l00046">46</a> of file <a class="el" href="mo_gen_sol_continue_8h-source.html">moGenSolContinue.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="8e2456421b641d38e3f800f3bbe45159"></a><!-- doxytag: member="moGenSolContinue::moGenSolContinue" ref="8e2456421b641d38e3f800f3bbe45159" args="(unsigned int _generationMaximumNumber)" -->
<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>_generationMaximumNumber</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Simple 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>_generationMaximumNumber</em>&nbsp;</td><td>The maximum number of generations. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="mo_gen_sol_continue_8h-source.html#l00054">54</a> of file <a class="el" href="mo_gen_sol_continue_8h-source.html">moGenSolContinue.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2fd5f2f10b6d6208412582578fad48ea"></a><!-- doxytag: member="moGenSolContinue::operator()" ref="2fd5f2f10b6d6208412582578fad48ea" args="(const EOT &amp;_solution)" -->
<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>_solution</em> </td>
<td>&nbsp;)&nbsp;</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 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>_solution</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>
<p>Definition at line <a class="el" href="mo_gen_sol_continue_8h-source.html#l00066">66</a> of file <a class="el" href="mo_gen_sol_continue_8h-source.html">moGenSolContinue.h</a>.</p>
<p>References <a class="el" href="mo_gen_sol_continue_8h-source.html#l00086">moGenSolContinue&lt; EOT &gt;::generationMaximumNumber</a>, and <a class="el" href="mo_gen_sol_continue_8h-source.html#l00089">moGenSolContinue&lt; EOT &gt;::generationNumber</a>.</p>
</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 the generation counter.
<p>
It can also be used to reset the iteration counter.
<p>Implements <a class="el" href="classmo_sol_continue.html#064dc966a210f4ffb9515be3f03ca4c7">moSolContinue&lt; EOT &gt;</a>.</p>
<p>Definition at line <a class="el" href="mo_gen_sol_continue_8h-source.html#l00078">78</a> of file <a class="el" href="mo_gen_sol_continue_8h-source.html">moGenSolContinue.h</a>.</p>
<p>References <a class="el" href="mo_gen_sol_continue_8h-source.html#l00089">moGenSolContinue&lt; EOT &gt;::generationNumber</a>.</p>
</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 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