paradiseo/trunk/paradiseo-moeo/doc/html/classmoeoNormalizedSolutionVsSolutionBinaryMetric.html
liefooga 320c6b06ff update doc with new stuffs
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@497 331e1502-861f-0410-8da2-ba01fb791d7f
2007-07-02 14:05:51 +00:00

178 lines
13 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: moeoNormalizedSolutionVsSolutionBinaryMetric&lt; ObjectiveVector, R &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>moeoNormalizedSolutionVsSolutionBinaryMetric&lt; ObjectiveVector, R &gt; Class Template Reference</h1><!-- doxytag: class="moeoNormalizedSolutionVsSolutionBinaryMetric" --><!-- doxytag: inherits="moeoSolutionVsSolutionBinaryMetric" -->Base class for binary metrics dedicated to the performance comparison between two solutions's objective vectors using normalized values.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoNormalizedSolutionVsSolutionBinaryMetric_8h-source.html">moeoNormalizedSolutionVsSolutionBinaryMetric.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoNormalizedSolutionVsSolutionBinaryMetric&lt; ObjectiveVector, R &gt;:
<p><center><img src="classmoeoNormalizedSolutionVsSolutionBinaryMetric.png" usemap="#moeoNormalizedSolutionVsSolutionBinaryMetric< ObjectiveVector, R >_map" border="0" alt=""></center>
<map name="moeoNormalizedSolutionVsSolutionBinaryMetric< ObjectiveVector, R >_map">
<area href="classmoeoSolutionVsSolutionBinaryMetric.html" alt="moeoSolutionVsSolutionBinaryMetric< ObjectiveVector, R >" shape="rect" coords="213,168,629,192">
<area href="classmoeoBinaryMetric.html" alt="moeoBinaryMetric< A1, A2, R >" shape="rect" coords="213,112,629,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,416,80">
<area href="classmoeoMetric.html" alt="moeoMetric" shape="rect" coords="426,56,842,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,416,24">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_functor_base.html" alt="eoFunctorBase" shape="rect" coords="426,0,842,24">
</map>
<a href="classmoeoNormalizedSolutionVsSolutionBinaryMetric-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"><a class="anchor" name="e58174a553269d3e8b0685a1f22b8333"></a><!-- doxytag: member="moeoNormalizedSolutionVsSolutionBinaryMetric::moeoNormalizedSolutionVsSolutionBinaryMetric" ref="e58174a553269d3e8b0685a1f22b8333" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoNormalizedSolutionVsSolutionBinaryMetric.html#e58174a553269d3e8b0685a1f22b8333">moeoNormalizedSolutionVsSolutionBinaryMetric</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default ctr for any <a class="el" href="classmoeoNormalizedSolutionVsSolutionBinaryMetric.html">moeoNormalizedSolutionVsSolutionBinaryMetric</a> object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoNormalizedSolutionVsSolutionBinaryMetric.html#1f56a2f59a9b0548ad0ab691c8a02334">setup</a> (double _min, double _max, unsigned int _obj)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the lower bound (_min) and the upper bound (_max) for the objective _obj. <a href="#1f56a2f59a9b0548ad0ab691c8a02334"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoNormalizedSolutionVsSolutionBinaryMetric.html#0693a23c68e3fe0bb546e34926dcfe93">setup</a> (<a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_real_interval.html">eoRealInterval</a> _realInterval, unsigned int _obj)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the lower bound and the upper bound for the objective _obj using a <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_real_interval.html">eoRealInterval</a> object. <a href="#0693a23c68e3fe0bb546e34926dcfe93"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d0ccbdceb71b9d2d6ae8ceec1af9dcdb"></a><!-- doxytag: member="moeoNormalizedSolutionVsSolutionBinaryMetric::tiny" ref="d0ccbdceb71b9d2d6ae8ceec1af9dcdb" args="()" -->
static double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoNormalizedSolutionVsSolutionBinaryMetric.html#d0ccbdceb71b9d2d6ae8ceec1af9dcdb">tiny</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a very small value that can be used to avoid extreme cases (where the min bound == the max bound). <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="81bff9a83c74f7f7f8a1db28c09c4c38"></a><!-- doxytag: member="moeoNormalizedSolutionVsSolutionBinaryMetric::bounds" ref="81bff9a83c74f7f7f8a1db28c09c4c38" args="" -->
std::vector&lt; <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_real_interval.html">eoRealInterval</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoNormalizedSolutionVsSolutionBinaryMetric.html#81bff9a83c74f7f7f8a1db28c09c4c38">bounds</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the bounds for every objective (bounds[i] = bounds for the objective i) <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class ObjectiveVector, class R&gt;<br>
class moeoNormalizedSolutionVsSolutionBinaryMetric&lt; ObjectiveVector, R &gt;</h3>
Base class for binary metrics dedicated to the performance comparison between two solutions's objective vectors using normalized values.
<p>
Then, indicator values lie in the interval [-1,1]. Note that you have to set the bounds for every objective before using the operator().
<p>
<p>
Definition at line <a class="el" href="moeoNormalizedSolutionVsSolutionBinaryMetric_8h-source.html#l00026">26</a> of file <a class="el" href="moeoNormalizedSolutionVsSolutionBinaryMetric_8h-source.html">moeoNormalizedSolutionVsSolutionBinaryMetric.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1f56a2f59a9b0548ad0ab691c8a02334"></a><!-- doxytag: member="moeoNormalizedSolutionVsSolutionBinaryMetric::setup" ref="1f56a2f59a9b0548ad0ab691c8a02334" args="(double _min, double _max, unsigned int _obj)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVector, class R&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmoeoNormalizedSolutionVsSolutionBinaryMetric.html">moeoNormalizedSolutionVsSolutionBinaryMetric</a>&lt; ObjectiveVector, R &gt;::setup </td>
<td>(</td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>_min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>_max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">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]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the lower bound (_min) and the upper bound (_max) for the objective _obj.
<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>_min</em>&nbsp;</td><td>lower bound </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_max</em>&nbsp;</td><td>upper bound </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_obj</em>&nbsp;</td><td>the objective index </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoNormalizedSolutionVsSolutionBinaryMetric_8h-source.html#l00050">50</a> of file <a class="el" href="moeoNormalizedSolutionVsSolutionBinaryMetric_8h-source.html">moeoNormalizedSolutionVsSolutionBinaryMetric.h</a>.
<p>
Referenced by <a class="el" href="moeoReferencePointIndicatorBasedFitnessAssignment_8h-source.html#l00078">moeoReferencePointIndicatorBasedFitnessAssignment&lt; MOEOT &gt;::setup()</a>, and <a class="el" href="moeoExpBinaryIndicatorBasedFitnessAssignment_8h-source.html#l00130">moeoExpBinaryIndicatorBasedFitnessAssignment&lt; MOEOT &gt;::setup()</a>.
</div>
</div><p>
<a class="anchor" name="0693a23c68e3fe0bb546e34926dcfe93"></a><!-- doxytag: member="moeoNormalizedSolutionVsSolutionBinaryMetric::setup" ref="0693a23c68e3fe0bb546e34926dcfe93" args="(eoRealInterval _realInterval, unsigned int _obj)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectiveVector, class R&gt; </div>
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classmoeoNormalizedSolutionVsSolutionBinaryMetric.html">moeoNormalizedSolutionVsSolutionBinaryMetric</a>&lt; ObjectiveVector, R &gt;::setup </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_real_interval.html">eoRealInterval</a>&nbsp;</td>
<td class="paramname"> <em>_realInterval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">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, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the lower bound and the upper bound for the objective _obj using a <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_real_interval.html">eoRealInterval</a> object.
<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>_realInterval</em>&nbsp;</td><td>the <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_real_interval.html">eoRealInterval</a> object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_obj</em>&nbsp;</td><td>the objective index </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoNormalizedSolutionVsSolutionBinaryMetric_8h-source.html#l00066">66</a> of file <a class="el" href="moeoNormalizedSolutionVsSolutionBinaryMetric_8h-source.html">moeoNormalizedSolutionVsSolutionBinaryMetric.h</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoNormalizedSolutionVsSolutionBinaryMetric_8h-source.html">moeoNormalizedSolutionVsSolutionBinaryMetric.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jul 2 16:05:02 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>