paradiseo/trunk/paradiseo-moeo/doc/html/classmoeoAggregativeComparator.html
legrand f5584011f5 regenerated doc because of licence section
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@657 331e1502-861f-0410-8da2-ba01fb791d7f
2007-10-08 08:55:53 +00:00

162 lines
9.5 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-MOEOMovingObjects: moeoAggregativeComparator&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.4.7 -->
<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>moeoAggregativeComparator&lt; MOEOT &gt; Class Template Reference</h1><!-- doxytag: class="moeoAggregativeComparator" --><!-- doxytag: inherits="moeoComparator" -->Functor allowing to compare two solutions according to their fitness and diversity values, each according to its aggregative value.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoAggregativeComparator_8h-source.html">moeoAggregativeComparator.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoAggregativeComparator&lt; MOEOT &gt;:
<p><center><img src="classmoeoAggregativeComparator.png" usemap="#moeoAggregativeComparator< MOEOT >_map" border="0" alt=""></center>
<map name="moeoAggregativeComparator< MOEOT >_map">
<area href="classmoeoComparator.html" alt="moeoComparator< MOEOT >" shape="rect" coords="0,112,247,136">
<area doxygen="eo.doxytag:http://eodev.sourceforge.net/eo/doc/html/" href="http://eodev.sourceforge.net/eo/doc/html/classeo_b_f.html" alt="eoBF< A1, A2, R >" shape="rect" coords="0,56,247,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,247,24">
</map>
<a href="classmoeoAggregativeComparator-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="classmoeoAggregativeComparator.html#76cc4d0f5f9bd4984c77410ad8142914">moeoAggregativeComparator</a> (double _weightFitness=1.0, double _weightDiversity=1.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ctor. <a href="#76cc4d0f5f9bd4984c77410ad8142914"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoAggregativeComparator.html#2f6745ebc2d575e64b162fc250f04b0f">operator()</a> (const MOEOT &amp;_moeo1, const MOEOT &amp;_moeo2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if _moeo1 &lt; _moeo2 according to the aggregation of their fitness and diversity values. <a href="#2f6745ebc2d575e64b162fc250f04b0f"></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="9ddf44b9e447bee8503c5b9cad9a7df0"></a><!-- doxytag: member="moeoAggregativeComparator::weightFitness" ref="9ddf44b9e447bee8503c5b9cad9a7df0" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoAggregativeComparator.html#9ddf44b9e447bee8503c5b9cad9a7df0">weightFitness</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the weight for fitness <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4ce25f797af0218c6c8cfca7c73b2d3"></a><!-- doxytag: member="moeoAggregativeComparator::weightDiversity" ref="d4ce25f797af0218c6c8cfca7c73b2d3" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoAggregativeComparator.html#d4ce25f797af0218c6c8cfca7c73b2d3">weightDiversity</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the weight for diversity <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class MOEOT&gt;<br>
class moeoAggregativeComparator&lt; MOEOT &gt;</h3>
Functor allowing to compare two solutions according to their fitness and diversity values, each according to its aggregative value.
<p>
<p>
Definition at line <a class="el" href="moeoAggregativeComparator_8h-source.html#l00022">22</a> of file <a class="el" href="moeoAggregativeComparator_8h-source.html">moeoAggregativeComparator.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="76cc4d0f5f9bd4984c77410ad8142914"></a><!-- doxytag: member="moeoAggregativeComparator::moeoAggregativeComparator" ref="76cc4d0f5f9bd4984c77410ad8142914" args="(double _weightFitness=1.0, double _weightDiversity=1.0)" -->
<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="classmoeoAggregativeComparator.html">moeoAggregativeComparator</a>&lt; MOEOT &gt;::<a class="el" href="classmoeoAggregativeComparator.html">moeoAggregativeComparator</a> </td>
<td>(</td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>_weightFitness</em> = <code>1.0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>_weightDiversity</em> = <code>1.0</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>_weightFitness</em>&nbsp;</td><td>the weight for fitness </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_weightDiversity</em>&nbsp;</td><td>the weight for diversity </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoAggregativeComparator_8h-source.html#l00031">31</a> of file <a class="el" href="moeoAggregativeComparator_8h-source.html">moeoAggregativeComparator.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2f6745ebc2d575e64b162fc250f04b0f"></a><!-- doxytag: member="moeoAggregativeComparator::operator()" ref="2f6745ebc2d575e64b162fc250f04b0f" args="(const MOEOT &amp;_moeo1, const MOEOT &amp;_moeo2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT&gt; </div>
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="classmoeoAggregativeComparator.html">moeoAggregativeComparator</a>&lt; MOEOT &gt;::operator() </td>
<td>(</td>
<td class="paramtype">const MOEOT &amp;&nbsp;</td>
<td class="paramname"> <em>_moeo1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const MOEOT &amp;&nbsp;</td>
<td class="paramname"> <em>_moeo2</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 true if _moeo1 &lt; _moeo2 according to the aggregation of their fitness and diversity 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>_moeo1</em>&nbsp;</td><td>the first solution </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_moeo2</em>&nbsp;</td><td>the second solution </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoAggregativeComparator_8h-source.html#l00040">40</a> of file <a class="el" href="moeoAggregativeComparator_8h-source.html">moeoAggregativeComparator.h</a>.
<p>
References <a class="el" href="moeoAggregativeComparator_8h-source.html#l00051">moeoAggregativeComparator&lt; MOEOT &gt;::weightDiversity</a>, and <a class="el" href="moeoAggregativeComparator_8h-source.html#l00049">moeoAggregativeComparator&lt; MOEOT &gt;::weightFitness</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoAggregativeComparator_8h-source.html">moeoAggregativeComparator.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Oct 8 10:35:52 2007 for ParadisEO-MOEOMovingObjects by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>