paradiseo/trunk/paradiseo-eo/doc/html/classeo_scalar_fitness_assembled.html
legrand c3aec878e5 Paradiseo-eo sources added
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
2006-12-12 14:49:08 +00:00

145 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>EO: eoScalarFitnessAssembled&lt; ScalarType, Compare, FitnessTraits &gt; Class Template 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>eoScalarFitnessAssembled&lt; ScalarType, Compare, FitnessTraits &gt; Class Template Reference</h1>Implements fitness as std::vector, storing all values that might occur during fitness assembly.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="eo_scalar_fitness_assembled_8h-source.html">eoScalarFitnessAssembled.h</a>&gt;</code>
<p>
<a href="classeo_scalar_fitness_assembled-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="w0" doxytag="eoScalarFitnessAssembled::baseVector"></a>
typedef std::vector&lt; ScalarType &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>baseVector</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="w1" doxytag="eoScalarFitnessAssembled::size_type"></a>
typedef baseVector::size_type&nbsp;</td><td class="memItemRight" valign="bottom"><b>size_type</b></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="a1" doxytag="eoScalarFitnessAssembled::eoScalarFitnessAssembled"></a>
&nbsp;</td><td class="memItemRight" valign="bottom"><b>eoScalarFitnessAssembled</b> (size_type _n, const ScalarType &amp;_val, const std::string &amp;_descr="Unnamed variable")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="eoScalarFitnessAssembled::eoScalarFitnessAssembled"></a>
&nbsp;</td><td class="memItemRight" valign="bottom"><b>eoScalarFitnessAssembled</b> (const <a class="el" href="classeo_scalar_fitness_assembled.html">eoScalarFitnessAssembled</a> &amp;other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="eoScalarFitnessAssembled::operator="></a>
<a class="el" href="classeo_scalar_fitness_assembled.html">eoScalarFitnessAssembled</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classeo_scalar_fitness_assembled.html">eoScalarFitnessAssembled</a> &amp;other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="eoScalarFitnessAssembled::eoScalarFitnessAssembled"></a>
&nbsp;</td><td class="memItemRight" valign="bottom"><b>eoScalarFitnessAssembled</b> (const ScalarType &amp;v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="eoScalarFitnessAssembled::operator="></a>
<a class="el" href="classeo_scalar_fitness_assembled.html">eoScalarFitnessAssembled</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const ScalarType &amp;v)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="eoScalarFitnessAssembled::push_back"></a>
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_scalar_fitness_assembled.html#a6">push_back</a> (const ScalarType &amp;_val)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overload <a class="el" href="classeo_scalar_fitness_assembled.html#a6">push_back()</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="eoScalarFitnessAssembled::push_back"></a>
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_scalar_fitness_assembled.html#a7">push_back</a> (const ScalarType &amp;_val, const std::string &amp;_descr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overload <a class="el" href="classeo_scalar_fitness_assembled.html#a6">push_back()</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8" doxytag="eoScalarFitnessAssembled::resize"></a>
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_scalar_fitness_assembled.html#a8">resize</a> (size_type _n, const ScalarType &amp;_val=ScalarType(), const std::string &amp;_descr="Unnamed variable")</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overload <a class="el" href="classeo_scalar_fitness_assembled.html#a8">resize()</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="eoScalarFitnessAssembled::setDescription"></a>
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_scalar_fitness_assembled.html#a9">setDescription</a> (size_type _idx, std::string _descr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set description. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10" doxytag="eoScalarFitnessAssembled::getDescription"></a>
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_scalar_fitness_assembled.html#a10">getDescription</a> (size_type _idx)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get description. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11" doxytag="eoScalarFitnessAssembled::getDescriptionVector"></a>
std::vector&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_scalar_fitness_assembled.html#a11">getDescriptionVector</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get vector with descriptions. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12" doxytag="eoScalarFitnessAssembled::operator ScalarType"></a>
&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator ScalarType</b> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13" doxytag="eoScalarFitnessAssembled::printAll"></a>
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_scalar_fitness_assembled.html#a13">printAll</a> (std::ostream &amp;os) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print term values and descriptions. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14" doxytag="eoScalarFitnessAssembled::operator<"></a>
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&lt;</b> (const <a class="el" href="classeo_scalar_fitness_assembled.html">eoScalarFitnessAssembled</a> &amp;other) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a15" doxytag="eoScalarFitnessAssembled::operator>"></a>
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&gt;</b> (const <a class="el" href="classeo_scalar_fitness_assembled.html">eoScalarFitnessAssembled</a>&lt; ScalarType, Compare, FitnessTraits &gt; &amp;y) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a16" doxytag="eoScalarFitnessAssembled::operator<="></a>
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&lt;=</b> (const <a class="el" href="classeo_scalar_fitness_assembled.html">eoScalarFitnessAssembled</a>&lt; ScalarType, Compare, FitnessTraits &gt; &amp;y) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a17" doxytag="eoScalarFitnessAssembled::operator>="></a>
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator&gt;=</b> (const <a class="el" href="classeo_scalar_fitness_assembled.html">eoScalarFitnessAssembled</a>&lt; ScalarType, Compare, FitnessTraits &gt; &amp;y) const </td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o0" doxytag="eoScalarFitnessAssembled::feasible"></a>
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_scalar_fitness_assembled.html#o0">feasible</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Can be specified anywhere in fitness evaluation as an indicator if the individual is in some feasible range. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o1" doxytag="eoScalarFitnessAssembled::failed"></a>
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_scalar_fitness_assembled.html#o1">failed</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Can be specified anywhere in fitness evaluation as an indicator if the evaluation of the individual failed. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_scalar_fitness_assembled.html#o2">msg</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Can be specified anywhere in fitness evaluation. <a href="#o2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class ScalarType, class Compare, class FitnessTraits&gt;<br>
class eoScalarFitnessAssembled&lt; ScalarType, Compare, FitnessTraits &gt;</h3>
Implements fitness as std::vector, storing all values that might occur during fitness assembly.
<p>
Properties:<ul>
<li>Wraps a scalar fitness values such as a double or int, with the option of maximizing (using less&lt;ScalarType&gt;) or minimizing (using greater&lt;ScalarType&gt;).</li><li>Stores all kinda different values met during fitness assembly, to be defined in <a class="el" href="classeo_eval_func.html">eoEvalFunc</a>.</li><li>It overrides operator&lt;() to use the Compare template argument.</li><li>Suitable constructors and assignments and casts are defined to work with this quantity as if it were a ScalarType.</li><li>Global fitness value is stored as first element in the vector </li></ul>
<p>
<p>
Definition at line <a class="el" href="eo_scalar_fitness_assembled_8h-source.html#l00088">88</a> of file <a class="el" href="eo_scalar_fitness_assembled_8h-source.html">eoScalarFitnessAssembled.h</a>.<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="o2" doxytag="eoScalarFitnessAssembled::msg"></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" colspan="4">
template&lt;class ScalarType, class Compare, class FitnessTraits&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top">std::string <a class="el" href="classeo_scalar_fitness_assembled.html">eoScalarFitnessAssembled</a>&lt; ScalarType, Compare, FitnessTraits &gt;::<a class="el" href="classeo_scalar_fitness_assembled.html#o2">msg</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Can be specified anywhere in fitness evaluation.
<p>
Typically used to store some sort of error messages, if evaluation of individual failed.
<p>
Definition at line <a class="el" href="eo_scalar_fitness_assembled_8h-source.html#l00195">195</a> of file <a class="el" href="eo_scalar_fitness_assembled_8h-source.html">eoScalarFitnessAssembled.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="eo_scalar_fitness_assembled_8h-source.html">eoScalarFitnessAssembled.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Oct 19 05:06:55 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>