paradiseo/trunk/paradiseo-moeo/docs/html/classmoeoEasyEA.html
liefooga 2e7e817428 update docs
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@263 331e1502-861f-0410-8da2-ba01fb791d7f
2007-04-17 15:45:01 +00:00

218 lines
17 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ParadisEO-MOEO: moeoEasyEA&lt; MOEOT &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.1 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li id="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>moeoEasyEA&lt; MOEOT &gt; Class Template Reference</h1><!-- doxytag: class="moeoEasyEA" --><!-- doxytag: inherits="moeoEA" -->An easy class to design multi-objective evolutionary algorithms.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoEasyEA_8h-source.html">moeoEasyEA.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoEasyEA&lt; MOEOT &gt;:
<p><center><img src="classmoeoEasyEA.png" usemap="#moeoEasyEA< MOEOT >_map" border="0" alt=""></center>
<map name="moeoEasyEA< MOEOT >_map">
<area href="classmoeoEA.html" alt="moeoEA< MOEOT >" shape="rect" coords="0,168,219,192">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_algo.html" alt="eoAlgo< MOEOT >" shape="rect" coords="0,112,219,136">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_u_f.html" alt="eoUF< eoPop< MOEOT > &, void >" shape="rect" coords="0,56,219,80">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_functor_base.html" alt="eoFunctorBase" shape="rect" coords="0,0,219,24">
</map>
<a href="classmoeoEasyEA-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="classmoeoEasyEA.html#7fe81a5e24bd69d9f6de172d2bbe059a">moeoEasyEA</a> (<a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_continue.html">eoContinue</a>&lt; MOEOT &gt; &amp;_continuator, <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_eval_func.html">eoEvalFunc</a>&lt; MOEOT &gt; &amp;_eval, <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_breed.html">eoBreed</a>&lt; MOEOT &gt; &amp;_breed, <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_replacement.html">eoReplacement</a>&lt; MOEOT &gt; &amp;_replace, <a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;_fitnessEval, <a class="el" href="classmoeoDiversityAssignment.html">moeoDiversityAssignment</a>&lt; MOEOT &gt; &amp;_diversityEval, bool _evalFitAndDivBeforeSelection=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ctor. <a href="#7fe81a5e24bd69d9f6de172d2bbe059a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEasyEA.html#f18e8fd179fbb2b89f4a59d213317170">operator()</a> (<a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_pop.html">eoPop</a>&lt; MOEOT &gt; &amp;_pop)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Applies a few generation of evolution to the population _pop. <a href="#f18e8fd179fbb2b89f4a59d213317170"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f5b76acbaf99a6a3ee2710da07dde29"></a><!-- doxytag: member="moeoEasyEA::continuator" ref="5f5b76acbaf99a6a3ee2710da07dde29" args="" -->
<a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_continue.html">eoContinue</a>&lt; MOEOT &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEasyEA.html#5f5b76acbaf99a6a3ee2710da07dde29">continuator</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the stopping criteria <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26e8ebce6a1bc3216e20171688ba6b83"></a><!-- doxytag: member="moeoEasyEA::eval" ref="26e8ebce6a1bc3216e20171688ba6b83" args="" -->
<a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_eval_func.html">eoEvalFunc</a>&lt; MOEOT &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEasyEA.html#26e8ebce6a1bc3216e20171688ba6b83">eval</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the evaluation functions <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1d492090805bf322c07159a9238a7ae"></a><!-- doxytag: member="moeoEasyEA::loopEval" ref="c1d492090805bf322c07159a9238a7ae" args="" -->
<a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_pop_loop_eval.html">eoPopLoopEval</a>&lt; MOEOT &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEasyEA.html#c1d492090805bf322c07159a9238a7ae">loopEval</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">to evaluate the whole population <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="189a8f5196844907ff71f386d95bf415"></a><!-- doxytag: member="moeoEasyEA::popEval" ref="189a8f5196844907ff71f386d95bf415" args="" -->
<a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_pop_eval_func.html">eoPopEvalFunc</a>&lt; MOEOT &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEasyEA.html#189a8f5196844907ff71f386d95bf415">popEval</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">to evaluate the whole population <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35d5909694019d1b0d52347c72a9092e"></a><!-- doxytag: member="moeoEasyEA::breed" ref="35d5909694019d1b0d52347c72a9092e" args="" -->
<a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_breed.html">eoBreed</a>&lt; MOEOT &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEasyEA.html#35d5909694019d1b0d52347c72a9092e">breed</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the breeder <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1872664368d198f983d11a96f0ee3d8d"></a><!-- doxytag: member="moeoEasyEA::replace" ref="1872664368d198f983d11a96f0ee3d8d" args="" -->
<a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_replacement.html">eoReplacement</a>&lt; MOEOT &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEasyEA.html#1872664368d198f983d11a96f0ee3d8d">replace</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the replacment strategy <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1268fc2f0b62fe51bca17d4efb51954b"></a><!-- doxytag: member="moeoEasyEA::fitnessEval" ref="1268fc2f0b62fe51bca17d4efb51954b" args="" -->
<a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEasyEA.html#1268fc2f0b62fe51bca17d4efb51954b">fitnessEval</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the fitness assignment strategy <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b9d1b3790072dbbbe0012a252bab95f4"></a><!-- doxytag: member="moeoEasyEA::diversityEval" ref="b9d1b3790072dbbbe0012a252bab95f4" args="" -->
<a class="el" href="classmoeoDiversityAssignment.html">moeoDiversityAssignment</a>&lt; MOEOT &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEasyEA.html#b9d1b3790072dbbbe0012a252bab95f4">diversityEval</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the diversity assignment strategy <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="856a19d9a7c180fe33ce7a5bb010edcc"></a><!-- doxytag: member="moeoEasyEA::evalFitAndDivBeforeSelection" ref="856a19d9a7c180fe33ce7a5bb010edcc" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEasyEA.html#856a19d9a7c180fe33ce7a5bb010edcc">evalFitAndDivBeforeSelection</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">if this parameter is set to 'true', the fitness and the diversity of the whole population will be re-evaluated before the selection process <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class MOEOT&gt;<br>
class moeoEasyEA&lt; MOEOT &gt;</h3>
An easy class to design multi-objective evolutionary algorithms.
<p>
<p>
Definition at line <a class="el" href="moeoEasyEA_8h-source.html#l00031">31</a> of file <a class="el" href="moeoEasyEA_8h-source.html">moeoEasyEA.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="7fe81a5e24bd69d9f6de172d2bbe059a"></a><!-- doxytag: member="moeoEasyEA::moeoEasyEA" ref="7fe81a5e24bd69d9f6de172d2bbe059a" args="(eoContinue&lt; MOEOT &gt; &amp;_continuator, eoEvalFunc&lt; MOEOT &gt; &amp;_eval, eoBreed&lt; MOEOT &gt; &amp;_breed, eoReplacement&lt; MOEOT &gt; &amp;_replace, moeoFitnessAssignment&lt; MOEOT &gt; &amp;_fitnessEval, moeoDiversityAssignment&lt; MOEOT &gt; &amp;_diversityEval, bool _evalFitAndDivBeforeSelection=false)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmoeoEasyEA.html">moeoEasyEA</a>&lt; MOEOT &gt;::<a class="el" href="classmoeoEasyEA.html">moeoEasyEA</a> </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_continue.html">eoContinue</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_continuator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_eval_func.html">eoEvalFunc</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_eval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_breed.html">eoBreed</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_breed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_replacement.html">eoReplacement</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_replace</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_fitnessEval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmoeoDiversityAssignment.html">moeoDiversityAssignment</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_diversityEval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>_evalFitAndDivBeforeSelection</em> = <code>false</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ctor.
<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>_continuator</em>&nbsp;</td><td>the stopping criteria </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_eval</em>&nbsp;</td><td>the evaluation functions </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_breed</em>&nbsp;</td><td>the breeder </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_replace</em>&nbsp;</td><td>the replacment strategy </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_fitnessEval</em>&nbsp;</td><td>the fitness evaluation scheme </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_diversityEval</em>&nbsp;</td><td>the diversity evaluation scheme </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_evalFitAndDivBeforeSelection</em>&nbsp;</td><td>put this parameter to 'true' if you want to re-evalue the fitness and the diversity of the population before the selection process </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoEasyEA_8h-source.html#l00045">45</a> of file <a class="el" href="moeoEasyEA_8h-source.html">moeoEasyEA.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f18e8fd179fbb2b89f4a59d213317170"></a><!-- doxytag: member="moeoEasyEA::operator()" ref="f18e8fd179fbb2b89f4a59d213317170" args="(eoPop&lt; MOEOT &gt; &amp;_pop)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT&gt; </div>
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classmoeoEasyEA.html">moeoEasyEA</a>&lt; MOEOT &gt;::operator() </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_pop.html">eoPop</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_pop</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Applies a few generation of evolution to the population _pop.
<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>_pop</em>&nbsp;</td><td>the population </td></tr>
</table>
</dl>
<p>
Implements <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_u_f.html#a1">eoUF&lt; eoPop&lt; MOEOT &gt; &amp;, void &gt;</a>.
<p>
Definition at line <a class="el" href="moeoEasyEA_8h-source.html#l00057">57</a> of file <a class="el" href="moeoEasyEA_8h-source.html">moeoEasyEA.h</a>.
<p>
References <a class="el" href="moeoEasyEA_8h-source.html#l00108">moeoEasyEA&lt; MOEOT &gt;::breed</a>, <a class="el" href="moeoEasyEA_8h-source.html#l00100">moeoEasyEA&lt; MOEOT &gt;::continuator</a>, <a class="el" href="moeoEasyEA_8h-source.html#l00114">moeoEasyEA&lt; MOEOT &gt;::diversityEval</a>, <a class="el" href="moeoEasyEA_8h-source.html#l00116">moeoEasyEA&lt; MOEOT &gt;::evalFitAndDivBeforeSelection</a>, <a class="el" href="moeoEasyEA_8h-source.html#l00112">moeoEasyEA&lt; MOEOT &gt;::fitnessEval</a>, <a class="el" href="moeoEasyEA_8h-source.html#l00106">moeoEasyEA&lt; MOEOT &gt;::popEval</a>, and <a class="el" href="moeoEasyEA_8h-source.html#l00110">moeoEasyEA&lt; MOEOT &gt;::replace</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoEasyEA_8h-source.html">moeoEasyEA.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Apr 17 16:53:21 2007 for ParadisEO-MOEO by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>