paradiseo/trunk/paradiseo-moeo/doc/html/classmoeoFrontByFrontSharingDiversityAssignment.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

248 lines
16 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: moeoFrontByFrontSharingDiversityAssignment&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>moeoFrontByFrontSharingDiversityAssignment&lt; MOEOT &gt; Class Template Reference</h1><!-- doxytag: class="moeoFrontByFrontSharingDiversityAssignment" --><!-- doxytag: inherits="moeoSharingDiversityAssignment" -->Sharing assignment scheme on the way it is used in NSGA.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html">moeoFrontByFrontSharingDiversityAssignment.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoFrontByFrontSharingDiversityAssignment&lt; MOEOT &gt;:
<p><center><img src="classmoeoFrontByFrontSharingDiversityAssignment.png" usemap="#moeoFrontByFrontSharingDiversityAssignment< MOEOT >_map" border="0" alt=""></center>
<map name="moeoFrontByFrontSharingDiversityAssignment< MOEOT >_map">
<area href="classmoeoSharingDiversityAssignment.html" alt="moeoSharingDiversityAssignment< MOEOT >" shape="rect" coords="0,168,345,192">
<area href="classmoeoDiversityAssignment.html" alt="moeoDiversityAssignment< MOEOT >" shape="rect" coords="0,112,345,136">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_u_f.html" alt="eoUF< eoPop< MOEOT > &, void >" shape="rect" coords="0,56,345,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,345,24">
</map>
<a href="classmoeoFrontByFrontSharingDiversityAssignment-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="c5350ba4340adea240c9cb362c1eb96d"></a><!-- doxytag: member="moeoFrontByFrontSharingDiversityAssignment::ObjectiveVector" ref="c5350ba4340adea240c9cb362c1eb96d" args="" -->
typedef MOEOT::ObjectiveVector&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoFrontByFrontSharingDiversityAssignment.html#c5350ba4340adea240c9cb362c1eb96d">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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoFrontByFrontSharingDiversityAssignment.html#a77c641d3d9184f60c3aace07fb1774f">moeoFrontByFrontSharingDiversityAssignment</a> (<a class="el" href="classmoeoDistance.html">moeoDistance</a>&lt; MOEOT, double &gt; &amp;_distance, double _nicheSize=0.5, double _alpha=2.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ctor. <a href="#a77c641d3d9184f60c3aace07fb1774f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoFrontByFrontSharingDiversityAssignment.html#fec74d6b140ff6bb98e80ca13d57b6d7">moeoFrontByFrontSharingDiversityAssignment</a> (double _nicheSize=0.5, double _alpha=2.0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ctor with an euclidean distance (with normalized objective values) in the objective space is used as default. <a href="#fec74d6b140ff6bb98e80ca13d57b6d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoFrontByFrontSharingDiversityAssignment.html#623489a246f86cf24cc5860d32caa743">updateByDeleting</a> (<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, <a class="el" href="classmoeoFrontByFrontSharingDiversityAssignment.html#c5350ba4340adea240c9cb362c1eb96d">ObjectiveVector</a> &amp;_objVec)</td></tr>
<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoFrontByFrontSharingDiversityAssignment.html#a0f6c045237aba2857c4a9ec25679e69">setSimilarities</a> (<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 similarities FRONT BY FRONT for every solution contained in the population _pop. <a href="#a0f6c045237aba2857c4a9ec25679e69"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class MOEOT&gt;<br>
class moeoFrontByFrontSharingDiversityAssignment&lt; MOEOT &gt;</h3>
Sharing assignment scheme on the way it is used in NSGA.
<p>
<p>
Definition at line <a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html#l00022">22</a> of file <a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html">moeoFrontByFrontSharingDiversityAssignment.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a77c641d3d9184f60c3aace07fb1774f"></a><!-- doxytag: member="moeoFrontByFrontSharingDiversityAssignment::moeoFrontByFrontSharingDiversityAssignment" ref="a77c641d3d9184f60c3aace07fb1774f" args="(moeoDistance&lt; MOEOT, double &gt; &amp;_distance, double _nicheSize=0.5, double _alpha=2.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="classmoeoFrontByFrontSharingDiversityAssignment.html">moeoFrontByFrontSharingDiversityAssignment</a>&lt; MOEOT &gt;::<a class="el" href="classmoeoFrontByFrontSharingDiversityAssignment.html">moeoFrontByFrontSharingDiversityAssignment</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmoeoDistance.html">moeoDistance</a>&lt; MOEOT, double &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_distance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>_nicheSize</em> = <code>0.5</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>_alpha</em> = <code>2.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>_distance</em>&nbsp;</td><td>the distance used to compute the neighborhood of solutions (can be related to the decision space or the objective space) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_nicheSize</em>&nbsp;</td><td>neighborhood size in terms of radius distance (closely related to the way the distances are computed) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_alpha</em>&nbsp;</td><td>parameter used to regulate the shape of the sharing function </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html#l00036">36</a> of file <a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html">moeoFrontByFrontSharingDiversityAssignment.h</a>.
</div>
</div><p>
<a class="anchor" name="fec74d6b140ff6bb98e80ca13d57b6d7"></a><!-- doxytag: member="moeoFrontByFrontSharingDiversityAssignment::moeoFrontByFrontSharingDiversityAssignment" ref="fec74d6b140ff6bb98e80ca13d57b6d7" args="(double _nicheSize=0.5, double _alpha=2.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="classmoeoFrontByFrontSharingDiversityAssignment.html">moeoFrontByFrontSharingDiversityAssignment</a>&lt; MOEOT &gt;::<a class="el" href="classmoeoFrontByFrontSharingDiversityAssignment.html">moeoFrontByFrontSharingDiversityAssignment</a> </td>
<td>(</td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>_nicheSize</em> = <code>0.5</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>_alpha</em> = <code>2.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 with an euclidean distance (with normalized objective values) in the objective space is used as default.
<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>_nicheSize</em>&nbsp;</td><td>neighborhood size in terms of radius distance (closely related to the way the distances are computed) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_alpha</em>&nbsp;</td><td>parameter used to regulate the shape of the sharing function </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html#l00045">45</a> of file <a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html">moeoFrontByFrontSharingDiversityAssignment.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="623489a246f86cf24cc5860d32caa743"></a><!-- doxytag: member="moeoFrontByFrontSharingDiversityAssignment::updateByDeleting" ref="623489a246f86cf24cc5860d32caa743" args="(eoPop&lt; MOEOT &gt; &amp;_pop, ObjectiveVector &amp;_objVec)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmoeoFrontByFrontSharingDiversityAssignment.html">moeoFrontByFrontSharingDiversityAssignment</a>&lt; MOEOT &gt;::updateByDeleting </td>
<td>(</td>
<td class="paramtype"><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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmoeoFrontByFrontSharingDiversityAssignment.html#c5350ba4340adea240c9cb362c1eb96d">ObjectiveVector</a> &amp;&nbsp;</td>
<td class="paramname"> <em>_objVec</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>
<dl compact><dt><b>Warning:</b></dt><dd>NOT IMPLEMENTED, DO NOTHING ! Updates the diversity values of the whole population _pop by taking the deletion of the objective vector _objVec into account. </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>_pop</em>&nbsp;</td><td>the population </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_objVec</em>&nbsp;</td><td>the objective vector </td></tr>
</table>
</dl>
<dl compact><dt><b>Warning:</b></dt><dd>NOT IMPLEMENTED, DO NOTHING ! </dd></dl>
<p>
Reimplemented from <a class="el" href="classmoeoSharingDiversityAssignment.html#21c8d6e020af23b2be219b7e02248300">moeoSharingDiversityAssignment&lt; MOEOT &gt;</a>.
<p>
Definition at line <a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html#l00056">56</a> of file <a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html">moeoFrontByFrontSharingDiversityAssignment.h</a>.
</div>
</div><p>
<a class="anchor" name="a0f6c045237aba2857c4a9ec25679e69"></a><!-- doxytag: member="moeoFrontByFrontSharingDiversityAssignment::setSimilarities" ref="a0f6c045237aba2857c4a9ec25679e69" args="(eoPop&lt; MOEOT &gt; &amp;_pop)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmoeoFrontByFrontSharingDiversityAssignment.html">moeoFrontByFrontSharingDiversityAssignment</a>&lt; MOEOT &gt;::setSimilarities </td>
<td>(</td>
<td class="paramtype"><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, private, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets similarities FRONT BY FRONT for every solution 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="classmoeoSharingDiversityAssignment.html#c01f6ac1abba3799f5c4b6c0608dac55">moeoSharingDiversityAssignment&lt; MOEOT &gt;</a>.
<p>
Definition at line <a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html#l00074">74</a> of file <a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html">moeoFrontByFrontSharingDiversityAssignment.h</a>.
<p>
References <a class="el" href="moeoSharingDiversityAssignment_8h-source.html#l00089">moeoSharingDiversityAssignment&lt; MOEOT &gt;::distance</a>, <a class="el" href="moeoSharingDiversityAssignment_8h-source.html#l00093">moeoSharingDiversityAssignment&lt; MOEOT &gt;::nicheSize</a>, and <a class="el" href="moeoSharingDiversityAssignment_8h-source.html#l00125">moeoSharingDiversityAssignment&lt; MOEOT &gt;::sh()</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoFrontByFrontSharingDiversityAssignment_8h-source.html">moeoFrontByFrontSharingDiversityAssignment.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>