paradiseo/branches/paradiseo-moeo-1.0/doc/man/man3/moeoRouletteSelect.3
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

84 lines
1.9 KiB
Groff

.TH "moeoRouletteSelect" 3 "26 Jun 2007" "Version 1.0" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoRouletteSelect \- Selection strategy that selects ONE individual by using roulette wheel process.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoRouletteSelect.h>\fP
.PP
Inherits \fBmoeoSelectOne< MOEOT >< MOEOT >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoeoRouletteSelect\fP (unsigned int _tSize=2)"
.br
.RI "\fICtor. \fP"
.ti -1c
.RI "const MOEOT & \fBoperator()\fP (const \fBeoPop\fP< MOEOT > &_pop)"
.br
.RI "\fIApply the tournament to the given population. \fP"
.in -1c
.SS "Protected Attributes"
.in +1c
.ti -1c
.RI "double & \fBtSize\fP"
.br
.RI "\fIsize \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class MOEOT> class moeoRouletteSelect< MOEOT >"
Selection strategy that selects ONE individual by using roulette wheel process.
\fBWarning:\fP
.RS 4
This selection only uses fitness values (and not diversity values).
.RE
.PP
.PP
Definition at line 24 of file moeoRouletteSelect.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class MOEOT> \fBmoeoRouletteSelect\fP< MOEOT >::\fBmoeoRouletteSelect\fP (unsigned int _tSize = \fC2\fP)\fC [inline]\fP"
.PP
Ctor.
.PP
\fBParameters:\fP
.RS 4
\fI_tSize\fP the number of individuals in the tournament (default: 2)
.RE
.PP
.PP
Definition at line 32 of file moeoRouletteSelect.h.
.PP
References moeoRouletteSelect< MOEOT >::tSize.
.SH "Member Function Documentation"
.PP
.SS "template<class MOEOT> const MOEOT& \fBmoeoRouletteSelect\fP< MOEOT >::operator() (const \fBeoPop\fP< MOEOT > & _pop)\fC [inline]\fP"
.PP
Apply the tournament to the given population.
.PP
\fBParameters:\fP
.RS 4
\fI_pop\fP the population
.RE
.PP
.PP
Definition at line 48 of file moeoRouletteSelect.h.
.PP
References moeoRouletteSelect< MOEOT >::tSize.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.