Paradiseo-eo sources added

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
legrand 2006-12-12 14:49:08 +00:00
commit c3aec878e5
3609 changed files with 342772 additions and 0 deletions

View file

@ -0,0 +1,100 @@
<!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>EO: eoObject Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"> <form class="search" action="search.php" method="get">
<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<h1>eoObject Class Reference</h1>eoObject used to be the base class for the whole hierarchy, but this has changed.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="eo_object_8h-source.html">eoObject.h</a>&gt;</code>
<p>
<p>Inheritance diagram for eoObject:
<p><center><img src="classeo_object.png" usemap="#eoObject_map" border="0" alt=""></center>
<map name="eoObject_map">
<area href="class_e_o.html" alt="EO< F >" shape="rect" coords="251,56,492,80">
<area href="class_e_o.html" alt="EO< double >" shape="rect" coords="251,112,492,136">
<area href="class_e_o.html" alt="EO< EOT::Fitness >" shape="rect" coords="251,168,492,192">
<area href="class_e_o.html" alt="EO< Fit >" shape="rect" coords="251,224,492,248">
<area href="class_e_o.html" alt="EO< Fitness >" shape="rect" coords="251,280,492,304">
<area href="class_e_o.html" alt="EO< fitness_type >" shape="rect" coords="251,336,492,360">
<area href="class_e_o.html" alt="EO< fitnessT >" shape="rect" coords="251,392,492,416">
<area href="class_e_o.html" alt="EO< FitT >" shape="rect" coords="251,448,492,472">
<area href="class_e_o.html" alt="EO< FType >" shape="rect" coords="251,504,492,528">
<area href="class_e_o.html" alt="EO< phenotype >" shape="rect" coords="251,560,492,584">
<area href="class_e_o.html" alt="EO< PyFitness >" shape="rect" coords="251,616,492,640">
<area href="classeo_distribution.html" alt="eoDistribution< EOT >" shape="rect" coords="251,672,492,696">
<area href="classeo_factory.html" alt="eoFactory< EOClass >" shape="rect" coords="251,728,492,752">
<area href="classeo_factory.html" alt="eoFactory< eoOpSelector< eoClass > >" shape="rect" coords="251,784,492,808">
<area href="classeo_factory.html" alt="eoFactory< eoSelect< EOT > >" shape="rect" coords="251,840,492,864">
<area href="classeo_factory.html" alt="eoFactory< EOT >" shape="rect" coords="251,896,492,920">
<area href="classeo_parser.html" alt="eoParser" shape="rect" coords="251,952,492,976">
<area href="classeo_pop.html" alt="eoPop< EOT >" shape="rect" coords="251,1008,492,1032">
<area href="classeo_pop.html" alt="eoPop< Dummy >" shape="rect" coords="251,1064,492,1088">
<area href="classeo_pop.html" alt="eoPop< PyEO >" shape="rect" coords="251,1120,492,1144">
<area href="classeo_rng.html" alt="eoRng" shape="rect" coords="251,1176,492,1200">
</map>
<a href="classeo_object-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="a0" doxytag="eoObject::~eoObject"></a>
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_object.html#a0">~eoObject</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Virtual dtor. They are needed in virtual class hierarchies. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_object.html#a1">className</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the class id. <a href="#a1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
eoObject used to be the base class for the whole hierarchy, but this has changed.
<p>
eoObject is used to define a name (<a class="el" href="classeo_object.html#a1">className</a>#) that is used when loading or saving the state.<p>
Previously, this object also defined a print and read interface, but it´s been moved to <a class="el" href="classeo_printable.html">eoPrintable</a> and <a class="el" href="classeo_persistent.html">eoPersistent</a>.<p>
It is recommended that you only derive from eoObject in concrete classes. Some parts of <a class="el" href="class_e_o.html">EO</a> do not implement this yet, but that will change in the future. eoObject, together with <a class="el" href="classeo_persistent.html">eoPersistent</a> and <a class="el" href="classeo_printable.html">eoPrintable</a> provide a simple persistence framework that is only needed when the classes have state that changes at runtime.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classeo_persistent.html">eoPersistent</a> <a class="el" href="classeo_printable.html">eoPrintable</a>, <a class="el" href="classeo_state.html">eoState</a> </dd></dl>
<p>
<p>
Definition at line <a class="el" href="eo_object_8h-source.html#l00055">55</a> of file <a class="el" href="eo_object_8h-source.html">eoObject.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1" doxytag="eoObject::className"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual std::string eoObject::className </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return the class id.
<p>
This should be redefined in each class. Only "leaf" classes can be non-virtual.<p>
Maarten: removed the default implementation as this proved to be too error-prone: I found several classes that had a typo in className (like classname), which would print eoObject instead of their own. Having it pure will force the implementor to provide a name.
<p>
Implemented in <a class="el" href="class_e_o.html#z10_0">EO&lt; F &gt;</a>, <a class="el" href="classeo_factory.html#z13_0">eoFactory&lt; EOClass &gt;</a>, <a class="el" href="classeo_op_sel_mason.html#z17_0">eoOpSelMason&lt; eoClass &gt;</a>, <a class="el" href="classeo_pop.html#z19_1">eoPop&lt; EOT &gt;</a>, <a class="el" href="classeo_es_full.html#a1">eoEsFull&lt; Fit &gt;</a>, <a class="el" href="classeo_es_simple.html#a1">eoEsSimple&lt; Fit &gt;</a>, <a class="el" href="classeo_es_stdev.html#a1">eoEsStdev&lt; Fit &gt;</a>, <a class="el" href="classeo_real.html#a1">eoReal&lt; FitT &gt;</a>, <a class="el" href="classeo_bit.html#a1">eoBit&lt; FitT &gt;</a>, <a class="el" href="classeo_p_b_i_l_distrib.html#a6">eoPBILDistrib&lt; EOT &gt;</a>, <a class="el" href="classeo_parse_tree.html#a4">eoParseTree&lt; FType, Node &gt;</a>, <a class="el" href="classeo_string.html#z26_0">eoString&lt; fitnessT &gt;</a>, <a class="el" href="classeo_parser.html#a4">eoParser</a>, <a class="el" href="classeo_rng.html#a18">eoRng</a>, <a class="el" href="classeo_one_max.html#a2">eoOneMax&lt; FitT &gt;</a>, <a class="el" href="class_e_o.html#z10_0">EO&lt; double &gt;</a>, <a class="el" href="class_e_o.html#z10_0">EO&lt; EOT::Fitness &gt;</a>, <a class="el" href="class_e_o.html#z10_0">EO&lt; FitT &gt;</a>, <a class="el" href="class_e_o.html#z10_0">EO&lt; phenotype &gt;</a>, <a class="el" href="class_e_o.html#z10_0">EO&lt; fitnessT &gt;</a>, <a class="el" href="class_e_o.html#z10_0">EO&lt; Fit &gt;</a>, <a class="el" href="class_e_o.html#z10_0">EO&lt; FType &gt;</a>, <a class="el" href="class_e_o.html#z10_0">EO&lt; fitness_type &gt;</a>, <a class="el" href="class_e_o.html#z10_0">EO&lt; Fitness &gt;</a>, <a class="el" href="class_e_o.html#z10_0">EO&lt; PyFitness &gt;</a>, <a class="el" href="classeo_factory.html#z13_0">eoFactory&lt; eoOpSelector&lt; eoClass &gt; &gt;</a>, <a class="el" href="classeo_factory.html#z13_0">eoFactory&lt; EOT &gt;</a>, <a class="el" href="classeo_factory.html#z13_0">eoFactory&lt; eoSelect&lt; EOT &gt; &gt;</a>, <a class="el" href="classeo_pop.html#z19_1">eoPop&lt; PyEO &gt;</a>, and <a class="el" href="classeo_pop.html#z19_1">eoPop&lt; Dummy &gt;</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="eo_object_8h-source.html">eoObject.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Oct 19 05:06:52 2006 for EO by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
</body>
</html>