paradiseo/trunk/paradiseo-moeo/docs/html/classmoeoElitistReplacement.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

302 lines
20 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: moeoElitistReplacement&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>moeoElitistReplacement&lt; MOEOT &gt; Class Template Reference</h1><!-- doxytag: class="moeoElitistReplacement" --><!-- doxytag: inherits="moeoReplacement" -->Elitist replacement strategy that consists in keeping the N best individuals.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoElitistReplacement_8h-source.html">moeoElitistReplacement.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoElitistReplacement&lt; MOEOT &gt;:
<p><center><img src="classmoeoElitistReplacement.png" usemap="#moeoElitistReplacement< MOEOT >_map" border="0" alt=""></center>
<map name="moeoElitistReplacement< MOEOT >_map">
<area href="classmoeoReplacement.html" alt="moeoReplacement< MOEOT >" shape="rect" coords="0,168,348,192">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_replacement.html" alt="eoReplacement< MOEOT >" shape="rect" coords="0,112,348,136">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_b_f.html" alt="eoBF< eoPop< MOEOT > &, eoPop< MOEOT > &, void >" shape="rect" coords="0,56,348,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,348,24">
</map>
<a href="classmoeoElitistReplacement-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="classmoeoElitistReplacement.html#76d642bc51aef42444a01cd0f54832e2">moeoElitistReplacement</a> (<a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;_evalFitness, <a class="el" href="classmoeoDiversityAssignment.html">moeoDiversityAssignment</a>&lt; MOEOT &gt; &amp;_evalDiversity, <a class="el" href="classmoeoComparator.html">moeoComparator</a>&lt; MOEOT &gt; &amp;_comparator)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Full constructor. <a href="#76d642bc51aef42444a01cd0f54832e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoElitistReplacement.html#755797c869d35fdeb3467cb13faabb39">moeoElitistReplacement</a> (<a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;_evalFitness, <a class="el" href="classmoeoDiversityAssignment.html">moeoDiversityAssignment</a>&lt; MOEOT &gt; &amp;_evalDiversity)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor without comparator. <a href="#755797c869d35fdeb3467cb13faabb39"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoElitistReplacement.html#edb91a2a6450cc8da01b98da631d11ce">moeoElitistReplacement</a> (<a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;_evalFitness, <a class="el" href="classmoeoComparator.html">moeoComparator</a>&lt; MOEOT &gt; &amp;_comparator)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor without moeoDiversityAssignement. <a href="#edb91a2a6450cc8da01b98da631d11ce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoElitistReplacement.html#782c45dbc5d077b96db4f08b808488df">moeoElitistReplacement</a> (<a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;_evalFitness)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor without moeoDiversityAssignement nor <a class="el" href="classmoeoComparator.html">moeoComparator</a>. <a href="#782c45dbc5d077b96db4f08b808488df"></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="classmoeoElitistReplacement.html#0364c6ef9d16f7eb65caa9edfce69006">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;_parents, <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_pop.html">eoPop</a>&lt; MOEOT &gt; &amp;_offspring)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Replaces the first population by adding the individuals of the second one, sorting with a <a class="el" href="classmoeoComparator.html">moeoComparator</a> and resizing the whole population obtained. <a href="#0364c6ef9d16f7eb65caa9edfce69006"></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="caefe4d041453d2a5fb8ccedc5c9e351"></a><!-- doxytag: member="moeoElitistReplacement::evalFitness" ref="caefe4d041453d2a5fb8ccedc5c9e351" args="" -->
<a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoElitistReplacement.html#caefe4d041453d2a5fb8ccedc5c9e351">evalFitness</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="52ba3396f1d95337486b29a6a997c7c3"></a><!-- doxytag: member="moeoElitistReplacement::evalDiversity" ref="52ba3396f1d95337486b29a6a997c7c3" args="" -->
<a class="el" href="classmoeoDiversityAssignment.html">moeoDiversityAssignment</a>&lt; MOEOT &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoElitistReplacement.html#52ba3396f1d95337486b29a6a997c7c3">evalDiversity</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="642ddf2bf5d556b20d2bdddeaab9e968"></a><!-- doxytag: member="moeoElitistReplacement::comparator" ref="642ddf2bf5d556b20d2bdddeaab9e968" args="" -->
<a class="el" href="classmoeoComparator.html">moeoComparator</a>&lt; MOEOT &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoElitistReplacement.html#642ddf2bf5d556b20d2bdddeaab9e968">comparator</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the comparator (used to compare 2 individuals) <br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoElitistReplacement_1_1Cmp.html">Cmp</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This class is used to compare solutions in order to sort the population. <a href="classmoeoElitistReplacement_1_1Cmp.html#_details">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class MOEOT&gt;<br>
class moeoElitistReplacement&lt; MOEOT &gt;</h3>
Elitist replacement strategy that consists in keeping the N best individuals.
<p>
<p>
Definition at line <a class="el" href="moeoElitistReplacement_8h-source.html#l00024">24</a> of file <a class="el" href="moeoElitistReplacement_8h-source.html">moeoElitistReplacement.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="76d642bc51aef42444a01cd0f54832e2"></a><!-- doxytag: member="moeoElitistReplacement::moeoElitistReplacement" ref="76d642bc51aef42444a01cd0f54832e2" args="(moeoFitnessAssignment&lt; MOEOT &gt; &amp;_evalFitness, moeoDiversityAssignment&lt; MOEOT &gt; &amp;_evalDiversity, moeoComparator&lt; MOEOT &gt; &amp;_comparator)" -->
<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="classmoeoElitistReplacement.html">moeoElitistReplacement</a>&lt; MOEOT &gt;::<a class="el" href="classmoeoElitistReplacement.html">moeoElitistReplacement</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_evalFitness</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>_evalDiversity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmoeoComparator.html">moeoComparator</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_comparator</em></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>
Full 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>_evalFitness</em>&nbsp;</td><td>the fitness assignment strategy </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_evalDiversity</em>&nbsp;</td><td>the diversity assignment strategy </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_comparator</em>&nbsp;</td><td>the comparator (used to compare 2 individuals) </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoElitistReplacement_8h-source.html#l00034">34</a> of file <a class="el" href="moeoElitistReplacement_8h-source.html">moeoElitistReplacement.h</a>.
</div>
</div><p>
<a class="anchor" name="755797c869d35fdeb3467cb13faabb39"></a><!-- doxytag: member="moeoElitistReplacement::moeoElitistReplacement" ref="755797c869d35fdeb3467cb13faabb39" args="(moeoFitnessAssignment&lt; MOEOT &gt; &amp;_evalFitness, moeoDiversityAssignment&lt; MOEOT &gt; &amp;_evalDiversity)" -->
<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="classmoeoElitistReplacement.html">moeoElitistReplacement</a>&lt; MOEOT &gt;::<a class="el" href="classmoeoElitistReplacement.html">moeoElitistReplacement</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_evalFitness</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>_evalDiversity</em></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>
Constructor without comparator.
<p>
A moeoFitThenDivComparator is used as default. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_evalFitness</em>&nbsp;</td><td>the fitness assignment strategy </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_evalDiversity</em>&nbsp;</td><td>the diversity assignment strategy </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoElitistReplacement_8h-source.html#l00044">44</a> of file <a class="el" href="moeoElitistReplacement_8h-source.html">moeoElitistReplacement.h</a>.
</div>
</div><p>
<a class="anchor" name="edb91a2a6450cc8da01b98da631d11ce"></a><!-- doxytag: member="moeoElitistReplacement::moeoElitistReplacement" ref="edb91a2a6450cc8da01b98da631d11ce" args="(moeoFitnessAssignment&lt; MOEOT &gt; &amp;_evalFitness, moeoComparator&lt; MOEOT &gt; &amp;_comparator)" -->
<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="classmoeoElitistReplacement.html">moeoElitistReplacement</a>&lt; MOEOT &gt;::<a class="el" href="classmoeoElitistReplacement.html">moeoElitistReplacement</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_evalFitness</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmoeoComparator.html">moeoComparator</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_comparator</em></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>
Constructor without moeoDiversityAssignement.
<p>
A dummy diversity is used as default. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_evalFitness</em>&nbsp;</td><td>the fitness assignment strategy </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_comparator</em>&nbsp;</td><td>the comparator (used to compare 2 individuals) </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoElitistReplacement_8h-source.html#l00054">54</a> of file <a class="el" href="moeoElitistReplacement_8h-source.html">moeoElitistReplacement.h</a>.
</div>
</div><p>
<a class="anchor" name="782c45dbc5d077b96db4f08b808488df"></a><!-- doxytag: member="moeoElitistReplacement::moeoElitistReplacement" ref="782c45dbc5d077b96db4f08b808488df" args="(moeoFitnessAssignment&lt; MOEOT &gt; &amp;_evalFitness)" -->
<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="classmoeoElitistReplacement.html">moeoElitistReplacement</a>&lt; MOEOT &gt;::<a class="el" href="classmoeoElitistReplacement.html">moeoElitistReplacement</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmoeoFitnessAssignment.html">moeoFitnessAssignment</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_evalFitness</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor without moeoDiversityAssignement nor <a class="el" href="classmoeoComparator.html">moeoComparator</a>.
<p>
A moeoFitThenDivComparator and a dummy diversity are used as default. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_evalFitness</em>&nbsp;</td><td>the fitness assignment strategy </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoElitistReplacement_8h-source.html#l00064">64</a> of file <a class="el" href="moeoElitistReplacement_8h-source.html">moeoElitistReplacement.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0364c6ef9d16f7eb65caa9edfce69006"></a><!-- doxytag: member="moeoElitistReplacement::operator()" ref="0364c6ef9d16f7eb65caa9edfce69006" args="(eoPop&lt; MOEOT &gt; &amp;_parents, eoPop&lt; MOEOT &gt; &amp;_offspring)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmoeoElitistReplacement.html">moeoElitistReplacement</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>_parents</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_pop.html">eoPop</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_offspring</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>
Replaces the first population by adding the individuals of the second one, sorting with a <a class="el" href="classmoeoComparator.html">moeoComparator</a> and resizing the whole population obtained.
<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>_parents</em>&nbsp;</td><td>the population composed of the parents (the population you want to replace) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_offspring</em>&nbsp;</td><td>the offspring population </td></tr>
</table>
</dl>
<p>
Implements <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_b_f.html#a1">eoBF&lt; eoPop&lt; MOEOT &gt; &amp;, eoPop&lt; MOEOT &gt; &amp;, void &gt;</a>.
<p>
Definition at line <a class="el" href="moeoElitistReplacement_8h-source.html#l00074">74</a> of file <a class="el" href="moeoElitistReplacement_8h-source.html">moeoElitistReplacement.h</a>.
<p>
References <a class="el" href="moeoElitistReplacement_8h-source.html#l00100">moeoElitistReplacement&lt; MOEOT &gt;::comparator</a>, <a class="el" href="moeoElitistReplacement_8h-source.html#l00098">moeoElitistReplacement&lt; MOEOT &gt;::evalDiversity</a>, and <a class="el" href="moeoElitistReplacement_8h-source.html#l00096">moeoElitistReplacement&lt; MOEOT &gt;::evalFitness</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoElitistReplacement_8h-source.html">moeoElitistReplacement.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>