nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
paradiseo/trunk/paradiseo-moeo/docs/html/classmoeoArchive.html
liefooga 2e7e817428 update docs 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@263 331e1502-861f-0410-8da2-ba01fb791d7f
2007-04-17 15:45:01 +00:00

316 lines
19 KiB
HTML
Raw Blame History

<!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: moeoArchive&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.5.1 -->
<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>moeoArchive&lt; MOEOT &gt; Class Template Reference</h1><!-- doxytag: class="moeoArchive" --><!-- doxytag: inherits="eoPop&lt; MOEOT &gt;" -->An archive is a secondary population that stores non-dominated solutions.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoArchive_8h-source.html">moeoArchive.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoArchive&lt; MOEOT &gt;:
<p><center><img src="classmoeoArchive.png" usemap="#moeoArchive< MOEOT >_map" border="0" alt=""></center>
<map name="moeoArchive< MOEOT >_map">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_pop.html" alt="eoPop< MOEOT >" shape="rect" coords="83,112,240,136">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_object.html" alt="eoObject" shape="rect" coords="0,56,157,80">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_persistent.html" alt="eoPersistent" shape="rect" coords="167,56,324,80">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_printable.html" alt="eoPrintable" shape="rect" coords="167,0,324,24">
</map>
<a href="classmoeoArchive-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="655f6879b14d7b4e65ea03724e5ee601"></a><!-- doxytag: member="moeoArchive::ObjectiveVector" ref="655f6879b14d7b4e65ea03724e5ee601" args="" -->
typedef MOEOT::ObjectiveVector&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchive.html#655f6879b14d7b4e65ea03724e5ee601">ObjectiveVector</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The type of an objective vector for a solution. <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="classmoeoArchive.html#a593ca2122484d255b5aa5a0463bd913">moeoArchive</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default ctor. <a href="#a593ca2122484d255b5aa5a0463bd913"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchive.html#75e5fee339ca463405434f6f48497de0">moeoArchive</a> (<a class="el" href="classmoeoObjectiveVectorComparator.html">moeoObjectiveVectorComparator</a>&lt; <a class="el" href="classmoeoArchive.html#655f6879b14d7b4e65ea03724e5ee601">ObjectiveVector</a> &gt; &amp;_comparator)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ctor. <a href="#75e5fee339ca463405434f6f48497de0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchive.html#1b2bf2eb890736fbe72273b10a1a4f5a">dominates</a> (const <a class="el" href="classmoeoArchive.html#655f6879b14d7b4e65ea03724e5ee601">ObjectiveVector</a> &amp;_objectiveVector) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the current archive dominates _objectiveVector according to the <a class="el" href="classmoeoObjectiveVectorComparator.html">moeoObjectiveVectorComparator</a> given in the constructor. <a href="#1b2bf2eb890736fbe72273b10a1a4f5a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchive.html#4f6f369e3f3e8fcd4663b9939a380811">contains</a> (const <a class="el" href="classmoeoArchive.html#655f6879b14d7b4e65ea03724e5ee601">ObjectiveVector</a> &amp;_objectiveVector) const</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the current archive already contains a solution with the same objective values than _objectiveVector. <a href="#4f6f369e3f3e8fcd4663b9939a380811"></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="classmoeoArchive.html#6df0acd84cab4cb53682f2e6ca850e9a">update</a> (const MOEOT &amp;_moeo)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates the archive with a given individual _moeo. <a href="#6df0acd84cab4cb53682f2e6ca850e9a"></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="classmoeoArchive.html#877bf4f0937f6be263e2686df4e77cf3">update</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">Updates the archive with a given population _pop. <a href="#877bf4f0937f6be263e2686df4e77cf3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchive.html#937088a6054ba1b50db651f50dda3a72">equals</a> (const <a class="el" href="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt; &amp;_arch)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the current archive contains the same objective vectors than the given archive _arch. <a href="#937088a6054ba1b50db651f50dda3a72"></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="59d96d161a53b3ee50df8ca5ad0d0642"></a><!-- doxytag: member="moeoArchive::comparator" ref="59d96d161a53b3ee50df8ca5ad0d0642" args="" -->
<a class="el" href="classmoeoObjectiveVectorComparator.html">moeoObjectiveVectorComparator</a>&lt;<br>
<a class="el" href="classmoeoArchive.html#655f6879b14d7b4e65ea03724e5ee601">ObjectiveVector</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchive.html#59d96d161a53b3ee50df8ca5ad0d0642">comparator</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The <a class="el" href="classmoeoObjectiveVectorComparator.html">moeoObjectiveVectorComparator</a> used to compare solutions. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eefd5b82b1d7f7d60c72683da9cd8682"></a><!-- doxytag: member="moeoArchive::paretoComparator" ref="eefd5b82b1d7f7d60c72683da9cd8682" args="" -->
<a class="el" href="classmoeoParetoObjectiveVectorComparator.html">moeoParetoObjectiveVectorComparator</a>&lt;<br>
<a class="el" href="classmoeoArchive.html#655f6879b14d7b4e65ea03724e5ee601">ObjectiveVector</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchive.html#eefd5b82b1d7f7d60c72683da9cd8682">paretoComparator</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A <a class="el" href="classmoeoObjectiveVectorComparator.html">moeoObjectiveVectorComparator</a> based on Pareto dominance (used as default). <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class MOEOT&gt;<br>
class moeoArchive&lt; MOEOT &gt;</h3>
An archive is a secondary population that stores non-dominated solutions.
<p>
<p>
Definition at line <a class="el" href="moeoArchive_8h-source.html#l00023">23</a> of file <a class="el" href="moeoArchive_8h-source.html">moeoArchive.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a593ca2122484d255b5aa5a0463bd913"></a><!-- doxytag: member="moeoArchive::moeoArchive" ref="a593ca2122484d255b5aa5a0463bd913" args="()" -->
<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="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt;::<a class="el" href="classmoeoArchive.html">moeoArchive</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default ctor.
<p>
The <a class="el" href="classmoeoObjectiveVectorComparator.html">moeoObjectiveVectorComparator</a> used to compare solutions is based on Pareto dominance
<p>
Definition at line <a class="el" href="moeoArchive_8h-source.html#l00043">43</a> of file <a class="el" href="moeoArchive_8h-source.html">moeoArchive.h</a>.
</div>
</div><p>
<a class="anchor" name="75e5fee339ca463405434f6f48497de0"></a><!-- doxytag: member="moeoArchive::moeoArchive" ref="75e5fee339ca463405434f6f48497de0" args="(moeoObjectiveVectorComparator&lt; ObjectiveVector &gt; &amp;_comparator)" -->
<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="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt;::<a class="el" href="classmoeoArchive.html">moeoArchive</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmoeoObjectiveVectorComparator.html">moeoObjectiveVectorComparator</a>&lt; <a class="el" href="classmoeoArchive.html#655f6879b14d7b4e65ea03724e5ee601">ObjectiveVector</a> &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_comparator</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>_comparator</em>&nbsp;</td><td>the <a class="el" href="classmoeoObjectiveVectorComparator.html">moeoObjectiveVectorComparator</a> used to compare solutions </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoArchive_8h-source.html#l00051">51</a> of file <a class="el" href="moeoArchive_8h-source.html">moeoArchive.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1b2bf2eb890736fbe72273b10a1a4f5a"></a><!-- doxytag: member="moeoArchive::dominates" ref="1b2bf2eb890736fbe72273b10a1a4f5a" args="(const ObjectiveVector &amp;_objectiveVector) const" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT&gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt;::dominates </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmoeoArchive.html#655f6879b14d7b4e65ea03724e5ee601">ObjectiveVector</a> &amp;&nbsp;</td>
<td class="paramname"> <em>_objectiveVector</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the current archive dominates _objectiveVector according to the <a class="el" href="classmoeoObjectiveVectorComparator.html">moeoObjectiveVectorComparator</a> given in the constructor.
<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 objective vector to compare with the current archive </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoArchive_8h-source.html#l00059">59</a> of file <a class="el" href="moeoArchive_8h-source.html">moeoArchive.h</a>.
</div>
</div><p>
<a class="anchor" name="4f6f369e3f3e8fcd4663b9939a380811"></a><!-- doxytag: member="moeoArchive::contains" ref="4f6f369e3f3e8fcd4663b9939a380811" args="(const ObjectiveVector &amp;_objectiveVector) const" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT&gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt;::contains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmoeoArchive.html#655f6879b14d7b4e65ea03724e5ee601">ObjectiveVector</a> &amp;&nbsp;</td>
<td class="paramname"> <em>_objectiveVector</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the current archive already contains a solution with the same objective values than _objectiveVector.
<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 objective vector to compare with the current archive </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoArchive_8h-source.html#l00076">76</a> of file <a class="el" href="moeoArchive_8h-source.html">moeoArchive.h</a>.
<p>
Referenced by <a class="el" href="moeoArchive_8h-source.html#l00150">moeoArchive&lt; EOT &gt;::equals()</a>.
</div>
</div><p>
<a class="anchor" name="6df0acd84cab4cb53682f2e6ca850e9a"></a><!-- doxytag: member="moeoArchive::update" ref="6df0acd84cab4cb53682f2e6ca850e9a" args="(const MOEOT &amp;_moeo)" -->
<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="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt;::update </td>
<td>(</td>
<td class="paramtype">const MOEOT &amp;&nbsp;</td>
<td class="paramname"> <em>_moeo</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Updates the archive with a given individual _moeo.
<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>_moeo</em>&nbsp;</td><td>the given individual </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoArchive_8h-source.html#l00093">93</a> of file <a class="el" href="moeoArchive_8h-source.html">moeoArchive.h</a>.
<p>
Referenced by <a class="el" href="moeoArchive_8h-source.html#l00136">moeoArchive&lt; EOT &gt;::update()</a>.
</div>
</div><p>
<a class="anchor" name="877bf4f0937f6be263e2686df4e77cf3"></a><!-- doxytag: member="moeoArchive::update" ref="877bf4f0937f6be263e2686df4e77cf3" args="(const 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="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt;::update </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]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Updates the archive with a given 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 given population </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoArchive_8h-source.html#l00136">136</a> of file <a class="el" href="moeoArchive_8h-source.html">moeoArchive.h</a>.
</div>
</div><p>
<a class="anchor" name="937088a6054ba1b50db651f50dda3a72"></a><!-- doxytag: member="moeoArchive::equals" ref="937088a6054ba1b50db651f50dda3a72" args="(const moeoArchive&lt; MOEOT &gt; &amp;_arch)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class MOEOT&gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt;::equals </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_arch</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the current archive contains the same objective vectors than the given archive _arch.
<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>_arch</em>&nbsp;</td><td>the given archive </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoArchive_8h-source.html#l00150">150</a> of file <a class="el" href="moeoArchive_8h-source.html">moeoArchive.h</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoArchive_8h-source.html">moeoArchive.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Apr 17 16:53:21 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.5.1 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink