c3aec878e5
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
109 lines
2.8 KiB
Groff
109 lines
2.8 KiB
Groff
.TH "eoFileSnapshot" 3 "19 Oct 2006" "Version 0.9.4-cvs" "EO" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
eoFileSnapshot \- Prints snapshots of fitnesses to a (new) file every N generations.
|
|
|
|
.PP
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fC#include <eoFileSnapshot.h>\fP
|
|
.PP
|
|
Inherits \fBeoMonitor\fP.
|
|
.PP
|
|
Inherited by \fBeoFDCFileSnapshot< EOT >\fP, and \fBeoGnuplot1DSnapshot\fP.
|
|
.PP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "typedef std::vector< double > \fBvDouble\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "typedef \fBeoValueParam\fP< std::vector< double > > \fBvDoubleParam\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBeoFileSnapshot\fP (std::string _dirname, unsigned _frequency=1, std::string _filename='gen', std::string _delim=' ', unsigned _counter=0, bool _rmFiles=true)"
|
|
.br
|
|
.ti -1c
|
|
.RI "virtual bool \fBhasChanged\fP ()"
|
|
.br
|
|
.RI "\fIaccessor: has something changed (for gnuplot subclass) \fP"
|
|
.ti -1c
|
|
.RI "unsigned \fBgetCounter\fP ()"
|
|
.br
|
|
.RI "\fIaccessor to the counter: needed by the gnuplot subclass \fP"
|
|
.ti -1c
|
|
.RI "std::string \fBgetFileName\fP ()"
|
|
.br
|
|
.RI "\fIaccessor to the current filename: needed by the gnuplot subclass \fP"
|
|
.ti -1c
|
|
.RI "void \fBsetCurrentFileName\fP ()"
|
|
.br
|
|
.RI "\fIsets the current filename depending on the counter \fP"
|
|
.ti -1c
|
|
.RI "\fBeoMonitor\fP & \fBoperator()\fP (void)"
|
|
.br
|
|
.RI "\fIThe operator(void): opens the std::ostream and calls the write method. \fP"
|
|
.ti -1c
|
|
.RI "\fBeoMonitor\fP & \fBoperator()\fP (std::ostream &_os)"
|
|
.br
|
|
.RI "\fIThe operator(): write on an std::ostream. \fP"
|
|
.ti -1c
|
|
.RI "virtual const std::string \fBgetDirName\fP ()"
|
|
.br
|
|
.ti -1c
|
|
.RI "virtual const std::string \fBbaseFileName\fP ()"
|
|
.br
|
|
.ti -1c
|
|
.RI "void \fBadd\fP (const \fBeoParam\fP &_param)"
|
|
.br
|
|
.RI "\fIadd checks whether it is a std::vector of doubles \fP"
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "std::string \fBdirname\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "unsigned \fBfrequency\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::string \fBfilename\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::string \fBdelim\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "unsigned int \fBcounter\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::string \fBcurrentFileName\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "bool \fBboolChanged\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
Prints snapshots of fitnesses to a (new) file every N generations.
|
|
|
|
Assumes that the parameters that are passed to the monitor (method add in \fBeoMonitor.h\fP) are \fBeoValueParam\fP<std::vector<double> > of same size.
|
|
.PP
|
|
A dir is created and one file per snapshot is created there - so you can later generate a movie!
|
|
.PP
|
|
TODO: The counter is handled internally, but this should be changed so that you can pass e.g. an evalcounter (minor)
|
|
.PP
|
|
I failed to templatize everything so that it can handle \fBeoParam\fP<std::vector<T> > for any type T, simply calling their getValue method ...
|
|
.PP
|
|
Definition at line 53 of file eoFileSnapshot.h.
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for EO from the source code.
|