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

199 lines
14 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: moeoCrowdingDistanceDiversityAssignment&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>moeoCrowdingDistanceDiversityAssignment&lt; MOEOT &gt; Class Template Reference</h1><!-- doxytag: class="moeoCrowdingDistanceDiversityAssignment" --><!-- doxytag: inherits="moeoDiversityAssignment" -->Diversity assignment sheme based on crowding distance proposed in: K.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html">moeoCrowdingDistanceDiversityAssignment.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoCrowdingDistanceDiversityAssignment&lt; MOEOT &gt;:
<p><center><img src="classmoeoCrowdingDistanceDiversityAssignment.png" usemap="#moeoCrowdingDistanceDiversityAssignment< MOEOT >_map" border="0" alt=""></center>
<map name="moeoCrowdingDistanceDiversityAssignment< MOEOT >_map">
<area href="classmoeoDiversityAssignment.html" alt="moeoDiversityAssignment< MOEOT >" shape="rect" coords="0,112,329,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,329,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,329,24">
</map>
<a href="classmoeoCrowdingDistanceDiversityAssignment-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="7c5b1b763bf82e2d557586533b072a64"></a><!-- doxytag: member="moeoCrowdingDistanceDiversityAssignment::ObjectiveVector" ref="7c5b1b763bf82e2d557586533b072a64" args="" -->
typedef MOEOT::ObjectiveVector&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoCrowdingDistanceDiversityAssignment.html#7c5b1b763bf82e2d557586533b072a64">ObjectiveVector</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the objective vector type of the solutions <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="809f4454efda4c5b87b809b59afb9ce0"></a><!-- doxytag: member="moeoCrowdingDistanceDiversityAssignment::inf" ref="809f4454efda4c5b87b809b59afb9ce0" args="() const" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoCrowdingDistanceDiversityAssignment.html#809f4454efda4c5b87b809b59afb9ce0">inf</a> () const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a big value (regarded as infinite). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoCrowdingDistanceDiversityAssignment.html#7af5b14f4a0d288fd12fa6044b816c54">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">Computes diversity values for every solution contained in the population _pop. <a href="#7af5b14f4a0d288fd12fa6044b816c54"></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="classmoeoCrowdingDistanceDiversityAssignment.html#ac21453d018c0e5dc872ccf0d0893f18">updateByDeleting</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, <a class="el" href="classmoeoCrowdingDistanceDiversityAssignment.html#7c5b1b763bf82e2d557586533b072a64">ObjectiveVector</a> &amp;_objVec)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl class="warning" compact><dt><b>Warning:</b></dt><dd>NOT IMPLEMENTED, DO NOTHING ! Updates the diversity values of the whole population _pop by taking the deletion of the objective vector _objVec into account. </dd></dl>
<a href="#ac21453d018c0e5dc872ccf0d0893f18"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoCrowdingDistanceDiversityAssignment.html#4ade243e5a25ccdc4fb823b9afd7e411">setDistances</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">Sets the distance values. <a href="#4ade243e5a25ccdc4fb823b9afd7e411"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class MOEOT&gt;<br>
class moeoCrowdingDistanceDiversityAssignment&lt; MOEOT &gt;</h3>
Diversity assignment sheme based on crowding distance proposed in: K.
<p>
Deb, A. Pratap, S. Agarwal, T. Meyarivan, "A Fast and Elitist Multi-Objective Genetic Algorithm: NSGA-II", IEEE Transactions on Evolutionary Computation, vol. 6, no. 2 (2002). This strategy is, for instance, used in NSGA-II.
<p>
<p>
Definition at line <a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html#l00026">26</a> of file <a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html">moeoCrowdingDistanceDiversityAssignment.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7af5b14f4a0d288fd12fa6044b816c54"></a><!-- doxytag: member="moeoCrowdingDistanceDiversityAssignment::operator()" ref="7af5b14f4a0d288fd12fa6044b816c54" 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">void <a class="el" href="classmoeoCrowdingDistanceDiversityAssignment.html">moeoCrowdingDistanceDiversityAssignment</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>
Computes diversity values for every solution contained in 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="moeoCrowdingDistanceDiversityAssignment_8h-source.html#l00047">47</a> of file <a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html">moeoCrowdingDistanceDiversityAssignment.h</a>.
<p>
References <a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html#l00037">moeoCrowdingDistanceDiversityAssignment&lt; MOEOT &gt;::inf()</a>, and <a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html#l00082">moeoCrowdingDistanceDiversityAssignment&lt; MOEOT &gt;::setDistances()</a>.
</div>
</div><p>
<a class="anchor" name="ac21453d018c0e5dc872ccf0d0893f18"></a><!-- doxytag: member="moeoCrowdingDistanceDiversityAssignment::updateByDeleting" ref="ac21453d018c0e5dc872ccf0d0893f18" args="(eoPop&lt; MOEOT &gt; &amp;_pop, ObjectiveVector &amp;_objVec)" -->
<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="classmoeoCrowdingDistanceDiversityAssignment.html">moeoCrowdingDistanceDiversityAssignment</a>&lt; MOEOT &gt;::updateByDeleting </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmoeoCrowdingDistanceDiversityAssignment.html#7c5b1b763bf82e2d557586533b072a64">ObjectiveVector</a> &amp;&nbsp;</td>
<td class="paramname"> <em>_objVec</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>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>NOT IMPLEMENTED, DO NOTHING ! Updates the diversity values of the whole population _pop by taking the deletion of the objective vector _objVec into account. </dd></dl>
<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>
<tr><td valign="top"></td><td valign="top"><em>_objVec</em>&nbsp;</td><td>the objective vector </td></tr>
</table>
</dl>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>NOT IMPLEMENTED, DO NOTHING ! </dd></dl>
<p>
Implements <a class="el" href="classmoeoDiversityAssignment.html#57f400263b36664df6269f1b522cfdcb">moeoDiversityAssignment&lt; MOEOT &gt;</a>.
<p>
Definition at line <a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html#l00070">70</a> of file <a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html">moeoCrowdingDistanceDiversityAssignment.h</a>.
</div>
</div><p>
<a class="anchor" name="4ade243e5a25ccdc4fb823b9afd7e411"></a><!-- doxytag: member="moeoCrowdingDistanceDiversityAssignment::setDistances" ref="4ade243e5a25ccdc4fb823b9afd7e411" 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">void <a class="el" href="classmoeoCrowdingDistanceDiversityAssignment.html">moeoCrowdingDistanceDiversityAssignment</a>&lt; MOEOT &gt;::setDistances </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, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the distance values.
<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>
Definition at line <a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html#l00082">82</a> of file <a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html">moeoCrowdingDistanceDiversityAssignment.h</a>.
<p>
References <a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html#l00037">moeoCrowdingDistanceDiversityAssignment&lt; MOEOT &gt;::inf()</a>.
<p>
Referenced by <a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html#l00047">moeoCrowdingDistanceDiversityAssignment&lt; MOEOT &gt;::operator()()</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoCrowdingDistanceDiversityAssignment_8h-source.html">moeoCrowdingDistanceDiversityAssignment.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>