nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add doc

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@397 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
liefooga 2007-06-26 13:13:33 +00:00
commit b1d6dd41c0
575 changed files with 57465 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

171
branches/paradiseo-moeo-1.0/doc/html/classmoeoAdditiveEpsilonBinaryMetric.html Normal file
View file

@ -0,0 +1,171 @@
<!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: moeoAdditiveEpsilonBinaryMetric&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>moeoAdditiveEpsilonBinaryMetric&lt; ObjectiveVector &gt; Class Template Reference</h1><!-- doxytag: class="moeoAdditiveEpsilonBinaryMetric" --><!-- doxytag: inherits="moeoNormalizedSolutionVsSolutionBinaryMetric&lt; ObjectiveVector, double &gt;" -->Additive epsilon binary metric allowing to compare two objective vectors as proposed in Zitzler E., Thiele L., Laumanns M., Fonseca C.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoAdditiveEpsilonBinaryMetric_8h-source.html">moeoAdditiveEpsilonBinaryMetric.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoAdditiveEpsilonBinaryMetric&lt; ObjectiveVector &gt;:
<p><center><img src="classmoeoAdditiveEpsilonBinaryMetric.png" usemap="#moeoAdditiveEpsilonBinaryMetric< ObjectiveVector >_map" border="0" alt=""></center>
<map name="moeoAdditiveEpsilonBinaryMetric< ObjectiveVector >_map">
<area href="classmoeoNormalizedSolutionVsSolutionBinaryMetric.html" alt="moeoNormalizedSolutionVsSolutionBinaryMetric< ObjectiveVector, double >" shape="rect" coords="228,224,674,248">
<area href="classmoeoSolutionVsSolutionBinaryMetric.html" alt="moeoSolutionVsSolutionBinaryMetric< ObjectiveVector, double >" shape="rect" coords="228,168,674,192">
<area href="classmoeoBinaryMetric.html" alt="moeoBinaryMetric< A1, A2, R >" shape="rect" coords="228,112,674,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,446,80">
<area href="classmoeoMetric.html" alt="moeoMetric" shape="rect" coords="456,56,902,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,446,24">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_functor_base.html" alt="eoFunctorBase" shape="rect" coords="456,0,902,24">
</map>
<a href="classmoeoAdditiveEpsilonBinaryMetric-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="classmoeoAdditiveEpsilonBinaryMetric.html#545aa2c8e6dd93084276763c9d8a3709">operator()</a> (const ObjectiveVector &amp;_o1, const ObjectiveVector &amp;_o2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the minimal distance by which the objective vector _o1 must be translated in all objectives so that it weakly dominates the objective vector _o2. <a href="#545aa2c8e6dd93084276763c9d8a3709"></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">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoAdditiveEpsilonBinaryMetric.html#04253f76c832d24a3fd6bc574be54c46">epsilon</a> (const ObjectiveVector &amp;_o1, const ObjectiveVector &amp;_o2, const unsigned int _obj)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the epsilon value by which the objective vector _o1 must be translated in the objective _obj so that it dominates the objective vector _o2. <a href="#04253f76c832d24a3fd6bc574be54c46"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class ObjectiveVector&gt;<br>
class moeoAdditiveEpsilonBinaryMetric&lt; ObjectiveVector &gt;</h3>
Additive epsilon binary metric allowing to compare two objective vectors as proposed in Zitzler E., Thiele L., Laumanns M., Fonseca C.
<p>
M., Grunert da Fonseca V.: Performance Assessment of Multiobjective Optimizers: An Analysis and Review. IEEE Transactions on Evolutionary Computation 7(2), pp.117–132 (2003).
<p>
<p>
Definition at line <a class="el" href="moeoAdditiveEpsilonBinaryMetric_8h-source.html#l00024">24</a> of file <a class="el" href="moeoAdditiveEpsilonBinaryMetric_8h-source.html">moeoAdditiveEpsilonBinaryMetric.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="545aa2c8e6dd93084276763c9d8a3709"></a><!-- doxytag: member="moeoAdditiveEpsilonBinaryMetric::operator()" ref="545aa2c8e6dd93084276763c9d8a3709" args="(const ObjectiveVector &amp;_o1, const ObjectiveVector &amp;_o2)" -->
<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="classmoeoAdditiveEpsilonBinaryMetric.html">moeoAdditiveEpsilonBinaryMetric</a>&lt; ObjectiveVector &gt;::operator() </td>
<td>(</td>
<td class="paramtype">const ObjectiveVector &amp;&nbsp;</td>
<td class="paramname"> <em>_o1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ObjectiveVector &amp;&nbsp;</td>
<td class="paramname"> <em>_o2</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 minimal distance by which the objective vector _o1 must be translated in all objectives so that it weakly dominates the objective vector _o2.
<p>
<dl compact><dt><b>Warning:</b></dt><dd>don't forget to set the bounds for every objective before the call of this function </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_o1</em>&nbsp;</td><td>the first objective vector </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_o2</em>&nbsp;</td><td>the second objective vector </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoAdditiveEpsilonBinaryMetric_8h-source.html#l00035">35</a> of file <a class="el" href="moeoAdditiveEpsilonBinaryMetric_8h-source.html">moeoAdditiveEpsilonBinaryMetric.h</a>.
<p>
References <a class="el" href="moeoAdditiveEpsilonBinaryMetric_8h-source.html#l00064">moeoAdditiveEpsilonBinaryMetric&lt; ObjectiveVector &gt;::epsilon()</a>.
</div>
</div><p>
<a class="anchor" name="04253f76c832d24a3fd6bc574be54c46"></a><!-- doxytag: member="moeoAdditiveEpsilonBinaryMetric::epsilon" ref="04253f76c832d24a3fd6bc574be54c46" args="(const ObjectiveVector &amp;_o1, const ObjectiveVector &amp;_o2, const unsigned int _obj)" -->
<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="classmoeoAdditiveEpsilonBinaryMetric.html">moeoAdditiveEpsilonBinaryMetric</a>&lt; ObjectiveVector &gt;::epsilon </td>
<td>(</td>
<td class="paramtype">const ObjectiveVector &amp;&nbsp;</td>
<td class="paramname"> <em>_o1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ObjectiveVector &amp;&nbsp;</td>
<td class="paramname"> <em>_o2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned int&nbsp;</td>
<td class="paramname"> <em>_obj</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>
Returns the epsilon value by which the objective vector _o1 must be translated in the objective _obj so that it dominates the objective vector _o2.
<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>_o1</em>&nbsp;</td><td>the first objective vector </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_o2</em>&nbsp;</td><td>the second objective vector </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_obj</em>&nbsp;</td><td>the index of the objective </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoAdditiveEpsilonBinaryMetric_8h-source.html#l00064">64</a> of file <a class="el" href="moeoAdditiveEpsilonBinaryMetric_8h-source.html">moeoAdditiveEpsilonBinaryMetric.h</a>.
<p>
References <a class="el" href="moeoNormalizedSolutionVsSolutionBinaryMetric_8h-source.html#l00084">moeoNormalizedSolutionVsSolutionBinaryMetric&lt; ObjectiveVector, double &gt;::bounds</a>.
<p>
Referenced by <a class="el" href="moeoAdditiveEpsilonBinaryMetric_8h-source.html#l00035">moeoAdditiveEpsilonBinaryMetric&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="moeoAdditiveEpsilonBinaryMetric_8h-source.html">moeoAdditiveEpsilonBinaryMetric.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jun 26 15:13:04 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>