paradiseo/trunk/paradiseo-eo/doc/html/classeo_file_snapshot.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

110 lines
9.6 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: eoFileSnapshot 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>eoFileSnapshot Class Reference</h1>Prints snapshots of fitnesses to a (new) file every N generations.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="eo_file_snapshot_8h-source.html">eoFileSnapshot.h</a>&gt;</code>
<p>
<p>Inheritance diagram for eoFileSnapshot:
<p><center><img src="classeo_file_snapshot.png" usemap="#eoFileSnapshot_map" border="0" alt=""></center>
<map name="eoFileSnapshot_map">
<area href="classeo_monitor.html" alt="eoMonitor" shape="rect" coords="92,112,266,136">
<area href="classeo_f.html" alt="eoF< eoMonitor & >" shape="rect" coords="92,56,266,80">
<area href="classeo_functor_base.html" alt="eoFunctorBase" shape="rect" coords="92,0,266,24">
<area href="classeo_f_d_c_file_snapshot.html" alt="eoFDCFileSnapshot< EOT >" shape="rect" coords="0,224,174,248">
<area href="classeo_gnuplot1_d_snapshot.html" alt="eoGnuplot1DSnapshot" shape="rect" coords="184,224,358,248">
</map>
<a href="classeo_file_snapshot-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="eoFileSnapshot::vDouble"></a>
typedef std::vector&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>vDouble</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="w1" doxytag="eoFileSnapshot::vDoubleParam"></a>
typedef <a class="el" href="classeo_value_param.html">eoValueParam</a>&lt; std::vector&lt;<br>
double &gt; &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>vDoubleParam</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="a0" doxytag="eoFileSnapshot::eoFileSnapshot"></a>
&nbsp;</td><td class="memItemRight" valign="bottom"><b>eoFileSnapshot</b> (std::string _dirname, unsigned _frequency=1, std::string _filename="gen", std::string _delim=" ", unsigned _counter=0, bool _rmFiles=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="eoFileSnapshot::hasChanged"></a>
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_file_snapshot.html#a1">hasChanged</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">accessor: has something changed (for gnuplot subclass) <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="eoFileSnapshot::getCounter"></a>
unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_file_snapshot.html#a2">getCounter</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">accessor to the counter: needed by the gnuplot subclass <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="eoFileSnapshot::getFileName"></a>
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_file_snapshot.html#a3">getFileName</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">accessor to the current filename: needed by the gnuplot subclass <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="eoFileSnapshot::setCurrentFileName"></a>
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_file_snapshot.html#a4">setCurrentFileName</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">sets the current filename depending on the counter <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="eoFileSnapshot::operator()"></a>
<a class="el" href="classeo_monitor.html">eoMonitor</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_file_snapshot.html#a5">operator()</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The operator(void): opens the std::ostream and calls the write method. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="eoFileSnapshot::operator()"></a>
<a class="el" href="classeo_monitor.html">eoMonitor</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_file_snapshot.html#a6">operator()</a> (std::ostream &amp;_os)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The operator(): write on an std::ostream. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="eoFileSnapshot::getDirName"></a>
virtual const std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>getDirName</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8" doxytag="eoFileSnapshot::baseFileName"></a>
virtual const std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>baseFileName</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="eoFileSnapshot::add"></a>
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeo_file_snapshot.html#a9">add</a> (const <a class="el" href="classeo_param.html">eoParam</a> &amp;_param)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">add checks whether it is a std::vector of doubles <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="r0" doxytag="eoFileSnapshot::dirname"></a>
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>dirname</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r1" doxytag="eoFileSnapshot::frequency"></a>
unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><b>frequency</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r2" doxytag="eoFileSnapshot::filename"></a>
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>filename</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r3" doxytag="eoFileSnapshot::delim"></a>
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>delim</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r4" doxytag="eoFileSnapshot::counter"></a>
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><b>counter</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r5" doxytag="eoFileSnapshot::currentFileName"></a>
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><b>currentFileName</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="r6" doxytag="eoFileSnapshot::boolChanged"></a>
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>boolChanged</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Prints snapshots of fitnesses to a (new) file every N generations.
<p>
Assumes that the parameters that are passed to the monitor (method add in <a class="el" href="eo_monitor_8h.html">eoMonitor.h</a>) are <a class="el" href="classeo_value_param.html">eoValueParam</a>&lt;std::vector&lt;double&gt; &gt; of same size.<p>
A dir is created and one file per snapshot is created there - so you can later generate a movie!<p>
TODO: The counter is handled internally, but this should be changed so that you can pass e.g. an evalcounter (minor)<p>
I failed to templatize everything so that it can handle <a class="el" href="classeo_param.html">eoParam</a>&lt;std::vector&lt;T&gt; &gt; for any type T, simply calling their getValue method ...
<p>
<p>
Definition at line <a class="el" href="eo_file_snapshot_8h-source.html#l00053">53</a> of file <a class="el" href="eo_file_snapshot_8h-source.html">eoFileSnapshot.h</a>.<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="eo_file_snapshot_8h-source.html">eoFileSnapshot.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Oct 19 05:06:48 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>