paradiseo/trunk/paradiseo-moeo/doc/html/classmoeoGDominanceObjectiveVectorComparator.html
liefooga d6f197d8cd doc up-to-date
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@552 331e1502-861f-0410-8da2-ba01fb791d7f
2007-07-05 15:37:48 +00:00

194 lines
12 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: moeoGDominanceObjectiveVectorComparator&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.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>moeoGDominanceObjectiveVectorComparator&lt; ObjectiveVector &gt; Class Template Reference</h1><!-- doxytag: class="moeoGDominanceObjectiveVectorComparator" --><!-- doxytag: inherits="moeoObjectiveVectorComparator" -->This functor class allows to compare 2 objective vectors according to g-dominance.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html">moeoGDominanceObjectiveVectorComparator.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoGDominanceObjectiveVectorComparator&lt; ObjectiveVector &gt;:
<p><center><img src="classmoeoGDominanceObjectiveVectorComparator.png" usemap="#moeoGDominanceObjectiveVectorComparator< ObjectiveVector >_map" border="0" alt=""></center>
<map name="moeoGDominanceObjectiveVectorComparator< ObjectiveVector >_map">
<area href="classmoeoObjectiveVectorComparator.html" alt="moeoObjectiveVectorComparator< ObjectiveVector >" shape="rect" coords="0,112,388,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,388,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,388,24">
</map>
<a href="classmoeoGDominanceObjectiveVectorComparator-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="classmoeoGDominanceObjectiveVectorComparator.html#fc4e1f1201b6420d206b28ab98e9ea0d">moeoGDominanceObjectiveVectorComparator</a> (ObjectiveVector &amp;_ref)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ctor. <a href="#fc4e1f1201b6420d206b28ab98e9ea0d"></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="classmoeoGDominanceObjectiveVectorComparator.html#4b8c3496d77abf6e774333f3296e6d79">operator()</a> (const ObjectiveVector &amp;_objectiveVector1, const ObjectiveVector &amp;_objectiveVector2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if _objectiveVector1 is g-dominated by _objectiveVector2. <a href="#4b8c3496d77abf6e774333f3296e6d79"></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">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoGDominanceObjectiveVectorComparator.html#75bf5141369522563e60d4e3ac2ec9cb">flag</a> (const ObjectiveVector &amp;_objectiveVector)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the flag of _objectiveVector according to the reference point. <a href="#75bf5141369522563e60d4e3ac2ec9cb"></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="54cf089933c4d5d70ceb931c2b97ca68"></a><!-- doxytag: member="moeoGDominanceObjectiveVectorComparator::ref" ref="54cf089933c4d5d70ceb931c2b97ca68" args="" -->
ObjectiveVector &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoGDominanceObjectiveVectorComparator.html#54cf089933c4d5d70ceb931c2b97ca68">ref</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the reference point <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5768e6444e546f1da2f36ccabcfc1f70"></a><!-- doxytag: member="moeoGDominanceObjectiveVectorComparator::paretoComparator" ref="5768e6444e546f1da2f36ccabcfc1f70" args="" -->
<a class="el" href="classmoeoParetoObjectiveVectorComparator.html">moeoParetoObjectiveVectorComparator</a>&lt;<br>
ObjectiveVector &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoGDominanceObjectiveVectorComparator.html#5768e6444e546f1da2f36ccabcfc1f70">paretoComparator</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pareto comparator. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class ObjectiveVector&gt;<br>
class moeoGDominanceObjectiveVectorComparator&lt; ObjectiveVector &gt;</h3>
This functor class allows to compare 2 objective vectors according to g-dominance.
<p>
The concept of g-dominance as been introduced in: J. Molina, L. V. Santana, A. G. Hernandez-Diaz, C. A. Coello Coello, R. Caballero, "g-dominance: Reference point based dominance" (2007)
<p>
<p>
Definition at line <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html#l00025">25</a> of file <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html">moeoGDominanceObjectiveVectorComparator.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="fc4e1f1201b6420d206b28ab98e9ea0d"></a><!-- doxytag: member="moeoGDominanceObjectiveVectorComparator::moeoGDominanceObjectiveVectorComparator" ref="fc4e1f1201b6420d206b28ab98e9ea0d" args="(ObjectiveVector &amp;_ref)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVector&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmoeoGDominanceObjectiveVectorComparator.html">moeoGDominanceObjectiveVectorComparator</a>&lt; ObjectiveVector &gt;::<a class="el" href="classmoeoGDominanceObjectiveVectorComparator.html">moeoGDominanceObjectiveVectorComparator</a> </td>
<td>(</td>
<td class="paramtype">ObjectiveVector &amp;&nbsp;</td>
<td class="paramname"> <em>_ref</em> </td>
<td>&nbsp;)&nbsp;</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>_ref</em>&nbsp;</td><td>the reference point </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html#l00033">33</a> of file <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html">moeoGDominanceObjectiveVectorComparator.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4b8c3496d77abf6e774333f3296e6d79"></a><!-- doxytag: member="moeoGDominanceObjectiveVectorComparator::operator()" ref="4b8c3496d77abf6e774333f3296e6d79" args="(const ObjectiveVector &amp;_objectiveVector1, const ObjectiveVector &amp;_objectiveVector2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVector&gt; </div>
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="classmoeoGDominanceObjectiveVectorComparator.html">moeoGDominanceObjectiveVectorComparator</a>&lt; ObjectiveVector &gt;::operator() </td>
<td>(</td>
<td class="paramtype">const ObjectiveVector &amp;&nbsp;</td>
<td class="paramname"> <em>_objectiveVector1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ObjectiveVector &amp;&nbsp;</td>
<td class="paramname"> <em>_objectiveVector2</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 _objectiveVector1 is g-dominated by _objectiveVector2.
<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>_objectiveVector1</em>&nbsp;</td><td>the first objective vector </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_objectiveVector2</em>&nbsp;</td><td>the second objective vector </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html#l00042">42</a> of file <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html">moeoGDominanceObjectiveVectorComparator.h</a>.
<p>
References <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html#l00076">moeoGDominanceObjectiveVectorComparator&lt; ObjectiveVector &gt;::flag()</a>, and <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html#l00069">moeoGDominanceObjectiveVectorComparator&lt; ObjectiveVector &gt;::paretoComparator</a>.
</div>
</div><p>
<a class="anchor" name="75bf5141369522563e60d4e3ac2ec9cb"></a><!-- doxytag: member="moeoGDominanceObjectiveVectorComparator::flag" ref="75bf5141369522563e60d4e3ac2ec9cb" args="(const ObjectiveVector &amp;_objectiveVector)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVector&gt; </div>
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="classmoeoGDominanceObjectiveVectorComparator.html">moeoGDominanceObjectiveVectorComparator</a>&lt; ObjectiveVector &gt;::flag </td>
<td>(</td>
<td class="paramtype">const ObjectiveVector &amp;&nbsp;</td>
<td class="paramname"> <em>_objectiveVector</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the flag of _objectiveVector according to the reference point.
<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>_objectiveVector</em>&nbsp;</td><td>the first objective vector </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html#l00076">76</a> of file <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html">moeoGDominanceObjectiveVectorComparator.h</a>.
<p>
References <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html#l00067">moeoGDominanceObjectiveVectorComparator&lt; ObjectiveVector &gt;::ref</a>.
<p>
Referenced by <a class="el" href="moeoGDominanceObjectiveVectorComparator_8h-source.html#l00042">moeoGDominanceObjectiveVectorComparator&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="moeoGDominanceObjectiveVectorComparator_8h-source.html">moeoGDominanceObjectiveVectorComparator.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jul 5 17:36:47 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.4.7 </small></address>
</body>
</html>