paradiseo/branches/paradiseo-moeo-1.0/doc/html/classmoeoArchiveObjectiveVectorSavingUpdater.html
liefooga b1d6dd41c0 add doc
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@397 331e1502-861f-0410-8da2-ba01fb791d7f
2007-06-26 13:13:33 +00:00

145 lines
10 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: moeoArchiveObjectiveVectorSavingUpdater&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>moeoArchiveObjectiveVectorSavingUpdater&lt; MOEOT &gt; Class Template Reference</h1><!-- doxytag: class="moeoArchiveObjectiveVectorSavingUpdater" --><!-- doxytag: inherits="eoUpdater" -->This class allows to save the objective vectors of the solutions contained in an archive into a file at each generation.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="moeoArchiveObjectiveVectorSavingUpdater_8h-source.html">moeoArchiveObjectiveVectorSavingUpdater.h</a>&gt;</code>
<p>
<p>Inheritance diagram for moeoArchiveObjectiveVectorSavingUpdater&lt; MOEOT &gt;:
<p><center><img src="classmoeoArchiveObjectiveVectorSavingUpdater.png" usemap="#moeoArchiveObjectiveVectorSavingUpdater< MOEOT >_map" border="0" alt=""></center>
<map name="moeoArchiveObjectiveVectorSavingUpdater< MOEOT >_map">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_updater.html" alt="eoUpdater" shape="rect" coords="0,112,332,136">
<area doxygen="eo.doxytag:../../../paradiseo-eo/doc/html/" href="../../../paradiseo-eo/doc/html/classeo_f.html" alt="eoF< void >" shape="rect" coords="0,56,332,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,332,24">
</map>
<a href="classmoeoArchiveObjectiveVectorSavingUpdater-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchiveObjectiveVectorSavingUpdater.html#d9f70d24605ccd1e89c8b4ea4c96c333">moeoArchiveObjectiveVectorSavingUpdater</a> (<a class="el" href="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt; &amp;_arch, const std::string &amp;_filename, bool _count=false, int _id=-1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ctor. <a href="#d9f70d24605ccd1e89c8b4ea4c96c333"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f6770822c62463ee3b56f7a4c59a850"></a><!-- doxytag: member="moeoArchiveObjectiveVectorSavingUpdater::operator()" ref="0f6770822c62463ee3b56f7a4c59a850" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchiveObjectiveVectorSavingUpdater.html#0f6770822c62463ee3b56f7a4c59a850">operator()</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Saves the fitness of the archive's members into the file. <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="b252eed0ea4f837efefdcdd81d5c42a6"></a><!-- doxytag: member="moeoArchiveObjectiveVectorSavingUpdater::arch" ref="b252eed0ea4f837efefdcdd81d5c42a6" args="" -->
<a class="el" href="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchiveObjectiveVectorSavingUpdater.html#b252eed0ea4f837efefdcdd81d5c42a6">arch</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">local archive <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7571569a5fb6df07f5d4e72310ec4d4d"></a><!-- doxytag: member="moeoArchiveObjectiveVectorSavingUpdater::filename" ref="7571569a5fb6df07f5d4e72310ec4d4d" args="" -->
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchiveObjectiveVectorSavingUpdater.html#7571569a5fb6df07f5d4e72310ec4d4d">filename</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">target filename <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6eb54eb29152e2d357b1b975ce33c062"></a><!-- doxytag: member="moeoArchiveObjectiveVectorSavingUpdater::count" ref="6eb54eb29152e2d357b1b975ce33c062" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchiveObjectiveVectorSavingUpdater.html#6eb54eb29152e2d357b1b975ce33c062">count</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">this variable is set to true if a new file have to be created each time () is called and to false if the file only HAVE to be updated <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ea4722f75597976cf6a21a7fba3ddbc"></a><!-- doxytag: member="moeoArchiveObjectiveVectorSavingUpdater::counter" ref="5ea4722f75597976cf6a21a7fba3ddbc" args="" -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchiveObjectiveVectorSavingUpdater.html#5ea4722f75597976cf6a21a7fba3ddbc">counter</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">counter <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd6940347cf39a47085c4d0a7c558355"></a><!-- doxytag: member="moeoArchiveObjectiveVectorSavingUpdater::id" ref="cd6940347cf39a47085c4d0a7c558355" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmoeoArchiveObjectiveVectorSavingUpdater.html#cd6940347cf39a47085c4d0a7c558355">id</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">own ID <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class MOEOT&gt;<br>
class moeoArchiveObjectiveVectorSavingUpdater&lt; MOEOT &gt;</h3>
This class allows to save the objective vectors of the solutions contained in an archive into a file at each generation.
<p>
<p>
Definition at line <a class="el" href="moeoArchiveObjectiveVectorSavingUpdater_8h-source.html#l00028">28</a> of file <a class="el" href="moeoArchiveObjectiveVectorSavingUpdater_8h-source.html">moeoArchiveObjectiveVectorSavingUpdater.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="d9f70d24605ccd1e89c8b4ea4c96c333"></a><!-- doxytag: member="moeoArchiveObjectiveVectorSavingUpdater::moeoArchiveObjectiveVectorSavingUpdater" ref="d9f70d24605ccd1e89c8b4ea4c96c333" args="(moeoArchive&lt; MOEOT &gt; &amp;_arch, const std::string &amp;_filename, bool _count=false, int _id=-1)" -->
<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="classmoeoArchiveObjectiveVectorSavingUpdater.html">moeoArchiveObjectiveVectorSavingUpdater</a>&lt; MOEOT &gt;::<a class="el" href="classmoeoArchiveObjectiveVectorSavingUpdater.html">moeoArchiveObjectiveVectorSavingUpdater</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmoeoArchive.html">moeoArchive</a>&lt; MOEOT &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>_arch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&nbsp;</td>
<td class="paramname"> <em>_filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>_count</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>_id</em> = <code>-1</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>_arch</em>&nbsp;</td><td>local archive </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_filename</em>&nbsp;</td><td>target filename </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_count</em>&nbsp;</td><td>put this variable to true if you want a new file to be created each time () is called and to false if you only want the file to be updated </td></tr>
<tr><td valign="top"></td><td valign="top"><em>_id</em>&nbsp;</td><td>own ID </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="moeoArchiveObjectiveVectorSavingUpdater_8h-source.html#l00039">39</a> of file <a class="el" href="moeoArchiveObjectiveVectorSavingUpdater_8h-source.html">moeoArchiveObjectiveVectorSavingUpdater.h</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="moeoArchiveObjectiveVectorSavingUpdater_8h-source.html">moeoArchiveObjectiveVectorSavingUpdater.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jun 26 15:13:04 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>