paradiseo/trunk/paradiseo-mo/doc/html/classmo_fit_sol_continue.html
jboisson 7a47863fd2 I have forgotten to regenerate the documentation, it is done
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@589 331e1502-861f-0410-8da2-ba01fb791d7f
2007-08-03 14:40:30 +00:00

181 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: moFitSolContinue&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>moFitSolContinue&lt; EOT &gt; Class Template Reference</h1><!-- doxytag: class="moFitSolContinue" --><!-- 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_fit_sol_continue_8h-source.html">moFitSolContinue.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moFitSolContinue&lt; EOT &gt;:
<p><center><img src="classmo_fit_sol_continue.png" usemap="#moFitSolContinue< EOT >_map" border="0" alt=""></center>
<map name="moFitSolContinue< 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_fit_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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="369ed94a788d8bdc08d5554f7669376f"></a><!-- doxytag: member="moFitSolContinue::Fitness" ref="369ed94a788d8bdc08d5554f7669376f" args="" -->
typedef EOT::Fitness&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_fit_sol_continue.html#369ed94a788d8bdc08d5554f7669376f">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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_fit_sol_continue.html#b14f37ba88de4e12583b22f5aabeb682">moFitSolContinue</a> (<a class="el" href="classmo_fit_sol_continue.html#369ed94a788d8bdc08d5554f7669376f">Fitness</a> __fitness)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Basic constructor. <a href="#b14f37ba88de4e12583b22f5aabeb682"></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_fit_sol_continue.html#fa9f0a15f99c998115cae9b456403a27">operator()</a> (const EOT &amp;__sol)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function that activates the stopping criterion. <a href="#fa9f0a15f99c998115cae9b456403a27"></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_fit_sol_continue.html#670bd895b4edfcd3aebb40d2295d7f7c">init</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Procedure which allows to initialise all the stuff needed. <a href="#670bd895b4edfcd3aebb40d2295d7f7c"></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="87d0ba8f2f76f61c89317eed5f094dfc"></a><!-- doxytag: member="moFitSolContinue::fitness" ref="87d0ba8f2f76f61c89317eed5f094dfc" args="" -->
<a class="el" href="classmo_fit_sol_continue.html#369ed94a788d8bdc08d5554f7669376f">Fitness</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmo_fit_sol_continue.html#87d0ba8f2f76f61c89317eed5f094dfc">fitness</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fitness target. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class EOT&gt;<br>
class moFitSolContinue&lt; EOT &gt;</h3>
One possible stop criterion for a solution-based heuristic.
<p>
The stop criterion corresponds to a fitness threshold gained.
<p>
<p>
Definition at line <a class="el" href="mo_fit_sol_continue_8h-source.html#l00021">21</a> of file <a class="el" href="mo_fit_sol_continue_8h-source.html">moFitSolContinue.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b14f37ba88de4e12583b22f5aabeb682"></a><!-- doxytag: member="moFitSolContinue::moFitSolContinue" ref="b14f37ba88de4e12583b22f5aabeb682" args="(Fitness __fitness)" -->
<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_fit_sol_continue.html">moFitSolContinue</a>&lt; EOT &gt;::<a class="el" href="classmo_fit_sol_continue.html">moFitSolContinue</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmo_fit_sol_continue.html#369ed94a788d8bdc08d5554f7669376f">Fitness</a>&nbsp;</td>
<td class="paramname"> <em>__fitness</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>__fitness</em>&nbsp;</td><td>The fitness to reach. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="mo_fit_sol_continue_8h-source.html#l00033">33</a> of file <a class="el" href="mo_fit_sol_continue_8h-source.html">moFitSolContinue.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="fa9f0a15f99c998115cae9b456403a27"></a><!-- doxytag: member="moFitSolContinue::operator()" ref="fa9f0a15f99c998115cae9b456403a27" 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_fit_sol_continue.html">moFitSolContinue</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 stopping criterion.
<p>
Indicates if the fitness threshold has not yet been reached.<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 value of the fitness. </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_fit_sol_continue_8h-source.html#l00043">43</a> of file <a class="el" href="mo_fit_sol_continue_8h-source.html">moFitSolContinue.h</a>.
<p>
References <a class="el" href="mo_fit_sol_continue_8h-source.html#l00063">moFitSolContinue&lt; EOT &gt;::fitness</a>.
</div>
</div><p>
<a class="anchor" name="670bd895b4edfcd3aebb40d2295d7f7c"></a><!-- doxytag: member="moFitSolContinue::init" ref="670bd895b4edfcd3aebb40d2295d7f7c" 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_fit_sol_continue.html">moFitSolContinue</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 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_fit_sol_continue_8h-source.html#l00057">57</a> of file <a class="el" href="mo_fit_sol_continue_8h-source.html">moFitSolContinue.h</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mo_fit_sol_continue_8h-source.html">moFitSolContinue.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 3 16:38:57 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>