paradiseo/branches/paradiseo-moeo-1.0/doc/html/classmoeoNormalizedDistance.html
liefooga b1d6dd41c0 add doc
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@397 331e1502-861f-0410-8da2-ba01fb791d7f
2007-06-26 13:13:33 +00:00

220 lines
14 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: moeoNormalizedDistance&lt; MOEOT, Type &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>moeoNormalizedDistance&lt; MOEOT, Type &gt; Class Template Reference</h1><!-- doxytag: class="moeoNormalizedDistance" --><!-- doxytag: inherits="moeoDistance" -->The base class for double distance computation with normalized objective values (i.e.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoNormalizedDistance_8h-source.html">moeoNormalizedDistance.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoNormalizedDistance&lt; MOEOT, Type &gt;:
<p><center><img src="classmoeoNormalizedDistance.png" usemap="#moeoNormalizedDistance< MOEOT, Type >_map" border="0" alt=""></center>
<map name="moeoNormalizedDistance< MOEOT, Type >_map">
<area href="classmoeoDistance.html" alt="moeoDistance< MOEOT, Type >" shape="rect" coords="0,112,261,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,261,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,261,24">
</map>
<a href="classmoeoNormalizedDistance-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4009eb0c953bdc30b98dfc219774ce84"></a><!-- doxytag: member="moeoNormalizedDistance::ObjectiveVector" ref="4009eb0c953bdc30b98dfc219774ce84" args="" -->
typedef MOEOT::ObjectiveVector&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoNormalizedDistance.html#4009eb0c953bdc30b98dfc219774ce84">ObjectiveVector</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">the objective vector type of the solutions <br></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="d3948169e6781aaf5f1b5de7ae09ba89"></a><!-- doxytag: member="moeoNormalizedDistance::moeoNormalizedDistance" ref="d3948169e6781aaf5f1b5de7ae09ba89" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoNormalizedDistance.html#d3948169e6781aaf5f1b5de7ae09ba89">moeoNormalizedDistance</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default ctr. <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="classmoeoNormalizedDistance.html#b99ffed3c0ce6c9c10aef0a76d983bb1">setup</a> (const <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_pop.html">eoPop</a>&lt; MOEOT &gt; &amp;_pop)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the lower and the upper bounds for every objective using extremes values for solutions contained in the population _pop. <a href="#b99ffed3c0ce6c9c10aef0a76d983bb1"></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="classmoeoNormalizedDistance.html#e58bbf9eb90a8d2704f88d774d3fe1e1">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="#e58bbf9eb90a8d2704f88d774d3fe1e1"></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="classmoeoNormalizedDistance.html#dda4f95d7f6cae9dd1f4bf6cd8fb7c1c">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="#dda4f95d7f6cae9dd1f4bf6cd8fb7c1c"></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="3534fa0cebf35373baa77ce18cfe572a"></a><!-- doxytag: member="moeoNormalizedDistance::tiny" ref="3534fa0cebf35373baa77ce18cfe572a" args="()" -->
static double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoNormalizedDistance.html#3534fa0cebf35373baa77ce18cfe572a">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="db85a478b20f9d8ec0f34f30a15e7bdd"></a><!-- doxytag: member="moeoNormalizedDistance::bounds" ref="db85a478b20f9d8ec0f34f30a15e7bdd" 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="classmoeoNormalizedDistance.html#db85a478b20f9d8ec0f34f30a15e7bdd">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 MOEOT, class Type = double&gt;<br>
class moeoNormalizedDistance&lt; MOEOT, Type &gt;</h3>
The base class for double distance computation with normalized objective values (i.e.
<p>
between 0 and 1).
<p>
<p>
Definition at line <a class="el" href="moeoNormalizedDistance_8h-source.html#l00024">24</a> of file <a class="el" href="moeoNormalizedDistance_8h-source.html">moeoNormalizedDistance.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b99ffed3c0ce6c9c10aef0a76d983bb1"></a><!-- doxytag: member="moeoNormalizedDistance::setup" ref="b99ffed3c0ce6c9c10aef0a76d983bb1" args="(const eoPop&lt; MOEOT &gt; &amp;_pop)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT, class Type = double&gt; </div>
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classmoeoNormalizedDistance.html">moeoNormalizedDistance</a>&lt; MOEOT, Type &gt;::setup </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_pop.html">eoPop</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_pop</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the lower and the upper bounds for every objective using extremes values for solutions contained in the population _pop.
<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>_pop</em>&nbsp;</td><td>the population </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classmoeoDistance.html#1834a67c2a7a96f0c9a3c408108a8f8c">moeoDistance&lt; MOEOT, Type &gt;</a>.
<p>
Definition at line <a class="el" href="moeoNormalizedDistance_8h-source.html#l00059">59</a> of file <a class="el" href="moeoNormalizedDistance_8h-source.html">moeoNormalizedDistance.h</a>.
<p>
Referenced by <a class="el" href="moeoNormalizedDistance_8h-source.html#l00059">moeoNormalizedDistance&lt; MOEOT &gt;::setup()</a>.
</div>
</div><p>
<a class="anchor" name="e58bbf9eb90a8d2704f88d774d3fe1e1"></a><!-- doxytag: member="moeoNormalizedDistance::setup" ref="e58bbf9eb90a8d2704f88d774d3fe1e1" args="(double _min, double _max, unsigned int _obj)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT, class Type = double&gt; </div>
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classmoeoNormalizedDistance.html">moeoNormalizedDistance</a>&lt; MOEOT, Type &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, virtual]</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>
Reimplemented from <a class="el" href="classmoeoDistance.html#341c4fa39652871761053e85914a16ad">moeoDistance&lt; MOEOT, Type &gt;</a>.
<p>
Definition at line <a class="el" href="moeoNormalizedDistance_8h-source.html#l00083">83</a> of file <a class="el" href="moeoNormalizedDistance_8h-source.html">moeoNormalizedDistance.h</a>.
</div>
</div><p>
<a class="anchor" name="dda4f95d7f6cae9dd1f4bf6cd8fb7c1c"></a><!-- doxytag: member="moeoNormalizedDistance::setup" ref="dda4f95d7f6cae9dd1f4bf6cd8fb7c1c" args="(eoRealInterval _realInterval, unsigned int _obj)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT, class Type = double&gt; </div>
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classmoeoNormalizedDistance.html">moeoNormalizedDistance</a>&lt; MOEOT, Type &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>
Reimplemented from <a class="el" href="classmoeoDistance.html#b08e7b8c1bedb2993669ec0315fb2b73">moeoDistance&lt; MOEOT, Type &gt;</a>.
<p>
Definition at line <a class="el" href="moeoNormalizedDistance_8h-source.html#l00099">99</a> of file <a class="el" href="moeoNormalizedDistance_8h-source.html">moeoNormalizedDistance.h</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoNormalizedDistance_8h-source.html">moeoNormalizedDistance.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>