nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

doc update

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@157 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
liefooga 2007-01-15 14:01:11 +00:00
commit b0351ae298
301 changed files with 27492 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

111
trunk/paradiseo-moeo/docs/man/man3/moeoArchive.3 Normal file
View file

@ -0,0 +1,111 @@
.TH "moeoArchive" 3 "15 Jan 2007" "Version 0.1" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoArchive \- An archive is a secondary population that stores non-dominated solutions.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoArchive.h>\fP
.PP
Inherits \fBeoPop< EOT >< EOT >\fP.
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "typedef EOT::Fitness \fBEOFitness\fP"
.br
.RI "\fIThe fitness type of a solution. \fP"
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "bool \fBdominates\fP (const \fBEOFitness\fP &_fit) const"
.br
.RI "\fIReturns true if the current archive dominates _fit. \fP"
.ti -1c
.RI "bool \fBcontains\fP (const \fBEOFitness\fP &_fit) const"
.br
.RI "\fIReturns true if the current archive contains _fit. \fP"
.ti -1c
.RI "void \fBupdate\fP (const EOT &_eo)"
.br
.RI "\fIUpdates the archive with a given individual _eo. \fP"
.ti -1c
.RI "void \fBupdate\fP (const \fBeoPop\fP< EOT > &_pop)"
.br
.RI "\fIUpdates the archive with a given population _pop. \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class EOT> class moeoArchive< EOT >"
An archive is a secondary population that stores non-dominated solutions.
.PP
Definition at line 21 of file moeoArchive.h.
.SH "Member Function Documentation"
.PP
.SS "template<class EOT> bool \fBmoeoArchive\fP< EOT >::dominates (const \fBEOFitness\fP & _fit) const\fC [inline]\fP"
.PP
Returns true if the current archive dominates _fit.
.PP
\fBParameters:\fP
.RS 4
\fI_fit\fP the (Pareto) fitness to compare with the current archive
.RE
.PP
.PP
Definition at line 39 of file moeoArchive.h.
.PP
Referenced by moeoArchive< EOT >::update().
.SS "template<class EOT> bool \fBmoeoArchive\fP< EOT >::contains (const \fBEOFitness\fP & _fit) const\fC [inline]\fP"
.PP
Returns true if the current archive contains _fit.
.PP
\fBParameters:\fP
.RS 4
\fI_fit\fP the (Pareto) fitness to search within the current archive
.RE
.PP
.PP
Definition at line 51 of file moeoArchive.h.
.SS "template<class EOT> void \fBmoeoArchive\fP< EOT >::update (const EOT & _eo)\fC [inline]\fP"
.PP
Updates the archive with a given individual _eo.
.PP
\fBParameters:\fP
.RS 4
\fI_eo\fP the given individual
.RE
.PP
.PP
Definition at line 63 of file moeoArchive.h.
.PP
References moeoArchive< EOT >::dominates().
.PP
Referenced by moeoArchive< EOT >::update().
.SS "template<class EOT> void \fBmoeoArchive\fP< EOT >::update (const \fBeoPop\fP< EOT > & _pop)\fC [inline]\fP"
.PP
Updates the archive with a given population _pop.
.PP
\fBParameters:\fP
.RS 4
\fI_pop\fP the given population
.RE
.PP
.PP
Definition at line 98 of file moeoArchive.h.
.PP
References moeoArchive< EOT >::update().
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.