paradiseo/trunk/paradiseo-eo/doc/man/man3/eoPopStat.3
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

72 lines
2.4 KiB
Groff

.TH "eoPopStat" 3 "19 Oct 2006" "Version 0.9.4-cvs" "EO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
eoPopStat \- Thanks to MS/VC++, \fBeoParam\fP mechanism is unable to handle std::vectors of stats.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <eoPopStat.h>\fP
.PP
Inherits \fBeoStat< EOT, std::string >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBeoPopStat\fP (unsigned _howMany=0, std::string _desc='')"
.br
.RI "\fIdefault Ctor, void std::string by default, as it appears on the description line once at beginning of evolution. \fP"
.ti -1c
.RI "void \fBoperator()\fP (const \fBeoPop\fP< \fBEOT\fP > &_pop)"
.br
.RI "\fIFills the \fBvalue()\fP of the \fBeoParam\fP with the dump of the population. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "unsigned \fBcombien\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class EOT> class eoPopStat< EOT >"
Thanks to MS/VC++, \fBeoParam\fP mechanism is unable to handle std::vectors of stats.
This snippet is a workaround: This class will 'print' a whole population into a std::string - that you can later send to any stream This is the plain version - see eoPopString for the Sorted version
.PP
Note: this Stat should probably be used only within eoStdOutMonitor, and not inside an \fBeoFileMonitor\fP, as the \fBeoState\fP construct will work much better there.
.PP
Definition at line 51 of file eoPopStat.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class EOT> \fBeoPopStat\fP< \fBEOT\fP >::\fBeoPopStat\fP (unsigned _howMany = \fC0\fP, std::string _desc = \fC''\fP)\fC [inline]\fP"
.PP
default Ctor, void std::string by default, as it appears on the description line once at beginning of evolution.
.PP
and is meaningless there. _howMany defaults to 0, that is, the whole population
.PP
Definition at line 61 of file eoPopStat.h.
.SH "Member Function Documentation"
.PP
.SS "template<class EOT> void \fBeoPopStat\fP< \fBEOT\fP >::operator() (const \fBeoPop\fP< \fBEOT\fP > & _pop)\fC [inline, virtual]\fP"
.PP
Fills the \fBvalue()\fP of the \fBeoParam\fP with the dump of the population.
.PP
Adds a
.br
before so it does not get mixed up with the rest of the stats that are written by the monitor it is probably used from.
.PP
Implements \fBeoUF< const eoPop< EOT > &, void >\fP.
.PP
Definition at line 68 of file eoPopStat.h.
.PP
References eoValueParam< std::string >::value().
.SH "Author"
.PP
Generated automatically by Doxygen for EO from the source code.