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

296 lines
18 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: moeoEntropyMetric&lt; ObjectiveVector &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>moeoEntropyMetric&lt; ObjectiveVector &gt; Class Template Reference</h1><!-- doxytag: class="moeoEntropyMetric" --><!-- doxytag: inherits="moeoVectorVsVectorBinaryMetric&lt; ObjectiveVector, double &gt;" -->The entropy gives an idea of the diversity of a Pareto set relatively to another (Basseur, Seynhaeve, Talbi: 'Design of Multi-objective Evolutionary Algorithms: Application to the Flow-shop Scheduling Problem', in Proc.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoEntropyMetric_8h-source.html">moeoEntropyMetric.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoEntropyMetric&lt; ObjectiveVector &gt;:
<p><center><img src="classmoeoEntropyMetric.png" usemap="#moeoEntropyMetric< ObjectiveVector >_map" border="0" alt=""></center>
<map name="moeoEntropyMetric< ObjectiveVector >_map">
<area href="classmoeoVectorVsVectorBinaryMetric.html" alt="moeoVectorVsVectorBinaryMetric< ObjectiveVector, double >" shape="rect" coords="189,168,558,192">
<area href="classmoeoBinaryMetric.html" alt="moeoBinaryMetric< A1, A2, R >" shape="rect" coords="189,112,558,136">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_b_f.html" alt="eoBF< A1, A2, R >" shape="rect" coords="0,56,369,80">
<area href="classmoeoMetric.html" alt="moeoMetric" shape="rect" coords="379,56,748,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,369,24">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_functor_base.html" alt="eoFunctorBase" shape="rect" coords="379,0,748,24">
</map>
<a href="classmoeoEntropyMetric-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">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEntropyMetric.html#191a8cdda7873e20338e678c5a7b927b">operator()</a> (const std::vector&lt; ObjectiveVector &gt; &amp;_set1, const std::vector&lt; ObjectiveVector &gt; &amp;_set2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the entropy of the Pareto set '_set1' relatively to the Pareto set '_set2'. <a href="#191a8cdda7873e20338e678c5a7b927b"></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="classmoeoEntropyMetric.html#198a717fd0bab0bb91346399c1021f82">removeDominated</a> (std::vector&lt; ObjectiveVector &gt; &amp;_f)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes the dominated individuals contained in _f. <a href="#198a717fd0bab0bb91346399c1021f82"></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="classmoeoEntropyMetric.html#51dd04bdd0ac6315f4f5956fb726cec1">prenormalize</a> (const std::vector&lt; ObjectiveVector &gt; &amp;_f)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prenormalization. <a href="#51dd04bdd0ac6315f4f5956fb726cec1"></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="classmoeoEntropyMetric.html#2ed5771c3c611634b415f4be48cad172">normalize</a> (std::vector&lt; ObjectiveVector &gt; &amp;_f)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalization. <a href="#2ed5771c3c611634b415f4be48cad172"></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="classmoeoEntropyMetric.html#4b99c1842d780a89bda08e99a59e3e29">computeUnion</a> (const std::vector&lt; ObjectiveVector &gt; &amp;_f1, const std::vector&lt; ObjectiveVector &gt; &amp;_f2, std::vector&lt; ObjectiveVector &gt; &amp;_f)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Computation of the union of _f1 and _f2 in _f. <a href="#4b99c1842d780a89bda08e99a59e3e29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74cca13e6ea6d23c4cebb3af92a09ff9"></a><!-- doxytag: member="moeoEntropyMetric::howManyInNicheOf" ref="74cca13e6ea6d23c4cebb3af92a09ff9" args="(const std::vector&lt; ObjectiveVector &gt; &amp;_f, const ObjectiveVector &amp;_s, unsigned _size)" -->
unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEntropyMetric.html#74cca13e6ea6d23c4cebb3af92a09ff9">howManyInNicheOf</a> (const std::vector&lt; ObjectiveVector &gt; &amp;_f, const ObjectiveVector &amp;_s, unsigned _size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">How many in niche. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="670d6e5eb1a539aabc741138846bc747"></a><!-- doxytag: member="moeoEntropyMetric::euclidianDistance" ref="670d6e5eb1a539aabc741138846bc747" args="(const ObjectiveVector &amp;_set1, const ObjectiveVector &amp;_to, unsigned _deg=2)" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEntropyMetric.html#670d6e5eb1a539aabc741138846bc747">euclidianDistance</a> (const ObjectiveVector &amp;_set1, const ObjectiveVector &amp;_to, unsigned _deg=2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Euclidian distance. <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="e423d7d4416ef371ce7b0fd24c3212f8"></a><!-- doxytag: member="moeoEntropyMetric::vect_min_val" ref="e423d7d4416ef371ce7b0fd24c3212f8" args="" -->
std::vector&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEntropyMetric.html#e423d7d4416ef371ce7b0fd24c3212f8">vect_min_val</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of min values <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f5fad6d144520fd1403f774f98b18b99"></a><!-- doxytag: member="moeoEntropyMetric::vect_max_val" ref="f5fad6d144520fd1403f774f98b18b99" args="" -->
std::vector&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoEntropyMetric.html#f5fad6d144520fd1403f774f98b18b99">vect_max_val</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">vector of max values <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class ObjectiveVector&gt;<br>
class moeoEntropyMetric&lt; ObjectiveVector &gt;</h3>
The entropy gives an idea of the diversity of a Pareto set relatively to another (Basseur, Seynhaeve, Talbi: 'Design of Multi-objective Evolutionary Algorithms: Application to the Flow-shop Scheduling Problem', in Proc.
<p>
of the 2002 Congress on Evolutionary Computation, IEEE Press, pp. 1155-1156)
<p>
<p>
Definition at line <a class="el" href="moeoEntropyMetric_8h-source.html#l00023">23</a> of file <a class="el" href="moeoEntropyMetric_8h-source.html">moeoEntropyMetric.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="191a8cdda7873e20338e678c5a7b927b"></a><!-- doxytag: member="moeoEntropyMetric::operator()" ref="191a8cdda7873e20338e678c5a7b927b" args="(const std::vector&lt; ObjectiveVector &gt; &amp;_set1, const std::vector&lt; ObjectiveVector &gt; &amp;_set2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVector&gt; </div>
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classmoeoEntropyMetric.html">moeoEntropyMetric</a>&lt; ObjectiveVector &gt;::operator() </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; ObjectiveVector &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_set1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; ObjectiveVector &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_set2</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>
Returns the entropy of the Pareto set '_set1' relatively to the Pareto set '_set2'.
<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>_set1</em>&nbsp;</td><td>the first Pareto set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_set2</em>&nbsp;</td><td>the second Pareto set </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoEntropyMetric_8h-source.html#l00032">32</a> of file <a class="el" href="moeoEntropyMetric_8h-source.html">moeoEntropyMetric.h</a>.
<p>
References <a class="el" href="moeoEntropyMetric_8h-source.html#l00137">moeoEntropyMetric&lt; ObjectiveVector &gt;::computeUnion()</a>, <a class="el" href="moeoEntropyMetric_8h-source.html#l00155">moeoEntropyMetric&lt; ObjectiveVector &gt;::howManyInNicheOf()</a>, <a class="el" href="moeoEntropyMetric_8h-source.html#l00124">moeoEntropyMetric&lt; ObjectiveVector &gt;::normalize()</a>, <a class="el" href="moeoEntropyMetric_8h-source.html#l00102">moeoEntropyMetric&lt; ObjectiveVector &gt;::prenormalize()</a>, and <a class="el" href="moeoEntropyMetric_8h-source.html#l00081">moeoEntropyMetric&lt; ObjectiveVector &gt;::removeDominated()</a>.
</div>
</div><p>
<a class="anchor" name="198a717fd0bab0bb91346399c1021f82"></a><!-- doxytag: member="moeoEntropyMetric::removeDominated" ref="198a717fd0bab0bb91346399c1021f82" args="(std::vector&lt; ObjectiveVector &gt; &amp;_f)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVector&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmoeoEntropyMetric.html">moeoEntropyMetric</a>&lt; ObjectiveVector &gt;::removeDominated </td>
<td>(</td>
<td class="paramtype">std::vector&lt; ObjectiveVector &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_f</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Removes the dominated individuals contained in _f.
<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>_f</em>&nbsp;</td><td>a Pareto set </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoEntropyMetric_8h-source.html#l00081">81</a> of file <a class="el" href="moeoEntropyMetric_8h-source.html">moeoEntropyMetric.h</a>.
<p>
Referenced by <a class="el" href="moeoEntropyMetric_8h-source.html#l00032">moeoEntropyMetric&lt; ObjectiveVector &gt;::operator()()</a>.
</div>
</div><p>
<a class="anchor" name="51dd04bdd0ac6315f4f5956fb726cec1"></a><!-- doxytag: member="moeoEntropyMetric::prenormalize" ref="51dd04bdd0ac6315f4f5956fb726cec1" args="(const std::vector&lt; ObjectiveVector &gt; &amp;_f)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVector&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmoeoEntropyMetric.html">moeoEntropyMetric</a>&lt; ObjectiveVector &gt;::prenormalize </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; ObjectiveVector &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_f</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Prenormalization.
<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>_f</em>&nbsp;</td><td>a Pareto set </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoEntropyMetric_8h-source.html#l00102">102</a> of file <a class="el" href="moeoEntropyMetric_8h-source.html">moeoEntropyMetric.h</a>.
<p>
References <a class="el" href="moeoEntropyMetric_8h-source.html#l00074">moeoEntropyMetric&lt; ObjectiveVector &gt;::vect_max_val</a>, and <a class="el" href="moeoEntropyMetric_8h-source.html#l00072">moeoEntropyMetric&lt; ObjectiveVector &gt;::vect_min_val</a>.
<p>
Referenced by <a class="el" href="moeoEntropyMetric_8h-source.html#l00032">moeoEntropyMetric&lt; ObjectiveVector &gt;::operator()()</a>.
</div>
</div><p>
<a class="anchor" name="2ed5771c3c611634b415f4be48cad172"></a><!-- doxytag: member="moeoEntropyMetric::normalize" ref="2ed5771c3c611634b415f4be48cad172" args="(std::vector&lt; ObjectiveVector &gt; &amp;_f)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVector&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmoeoEntropyMetric.html">moeoEntropyMetric</a>&lt; ObjectiveVector &gt;::normalize </td>
<td>(</td>
<td class="paramtype">std::vector&lt; ObjectiveVector &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_f</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Normalization.
<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>_f</em>&nbsp;</td><td>a Pareto set </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoEntropyMetric_8h-source.html#l00124">124</a> of file <a class="el" href="moeoEntropyMetric_8h-source.html">moeoEntropyMetric.h</a>.
<p>
References <a class="el" href="moeoEntropyMetric_8h-source.html#l00074">moeoEntropyMetric&lt; ObjectiveVector &gt;::vect_max_val</a>, and <a class="el" href="moeoEntropyMetric_8h-source.html#l00072">moeoEntropyMetric&lt; ObjectiveVector &gt;::vect_min_val</a>.
<p>
Referenced by <a class="el" href="moeoEntropyMetric_8h-source.html#l00032">moeoEntropyMetric&lt; ObjectiveVector &gt;::operator()()</a>.
</div>
</div><p>
<a class="anchor" name="4b99c1842d780a89bda08e99a59e3e29"></a><!-- doxytag: member="moeoEntropyMetric::computeUnion" ref="4b99c1842d780a89bda08e99a59e3e29" args="(const std::vector&lt; ObjectiveVector &gt; &amp;_f1, const std::vector&lt; ObjectiveVector &gt; &amp;_f2, std::vector&lt; ObjectiveVector &gt; &amp;_f)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVector&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmoeoEntropyMetric.html">moeoEntropyMetric</a>&lt; ObjectiveVector &gt;::computeUnion </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; ObjectiveVector &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_f1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; ObjectiveVector &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_f2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; ObjectiveVector &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_f</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Computation of the union of _f1 and _f2 in _f.
<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>_f1</em>&nbsp;</td><td>the first Pareto set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_f2</em>&nbsp;</td><td>the second Pareto set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_f</em>&nbsp;</td><td>the final Pareto set </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoEntropyMetric_8h-source.html#l00137">137</a> of file <a class="el" href="moeoEntropyMetric_8h-source.html">moeoEntropyMetric.h</a>.
<p>
Referenced by <a class="el" href="moeoEntropyMetric_8h-source.html#l00032">moeoEntropyMetric&lt; ObjectiveVector &gt;::operator()()</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoEntropyMetric_8h-source.html">moeoEntropyMetric.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>