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

107 lines
2.9 KiB
Groff

.TH "moeoStochTournamentSelect" 3 "26 Jun 2007" "Version 1.0" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoStochTournamentSelect \- Selection strategy that selects ONE individual by stochastic tournament.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoStochTournamentSelect.h>\fP
.PP
Inherits \fBmoeoSelectOne< MOEOT >< MOEOT >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoeoStochTournamentSelect\fP (\fBmoeoComparator\fP< MOEOT > &_comparator, double _tRate=1.0)"
.br
.RI "\fIFull Ctor. \fP"
.ti -1c
.RI "\fBmoeoStochTournamentSelect\fP (double _tRate=1.0)"
.br
.RI "\fICtor without comparator. \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 "\fBmoeoComparator\fP< MOEOT > & \fBcomparator\fP"
.br
.RI "\fIthe comparator (used to compare 2 individuals) \fP"
.ti -1c
.RI "\fBmoeoFitnessThenDiversityComparator\fP< MOEOT > \fBdefaultComparator\fP"
.br
.RI "\fIa fitness then diversity comparator can be used as default \fP"
.ti -1c
.RI "double \fBtRate\fP"
.br
.RI "\fIthe tournament rate \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class MOEOT> class moeoStochTournamentSelect< MOEOT >"
Selection strategy that selects ONE individual by stochastic tournament.
.PP
Definition at line 24 of file moeoStochTournamentSelect.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class MOEOT> \fBmoeoStochTournamentSelect\fP< MOEOT >::\fBmoeoStochTournamentSelect\fP (\fBmoeoComparator\fP< MOEOT > & _comparator, double _tRate = \fC1.0\fP)\fC [inline]\fP"
.PP
Full Ctor.
.PP
\fBParameters:\fP
.RS 4
\fI_comparator\fP the comparator (used to compare 2 individuals)
.br
\fI_tRate\fP the tournament rate
.RE
.PP
.PP
Definition at line 33 of file moeoStochTournamentSelect.h.
.PP
References moeoStochTournamentSelect< MOEOT >::tRate.
.SS "template<class MOEOT> \fBmoeoStochTournamentSelect\fP< MOEOT >::\fBmoeoStochTournamentSelect\fP (double _tRate = \fC1.0\fP)\fC [inline]\fP"
.PP
Ctor without comparator.
.PP
A \fBmoeoFitnessThenDiversityComparator\fP is used as default.
.PP
\fBParameters:\fP
.RS 4
\fI_tRate\fP the tournament rate
.RE
.PP
.PP
Definition at line 53 of file moeoStochTournamentSelect.h.
.PP
References moeoStochTournamentSelect< MOEOT >::tRate.
.SH "Member Function Documentation"
.PP
.SS "template<class MOEOT> const MOEOT& \fBmoeoStochTournamentSelect\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 73 of file moeoStochTournamentSelect.h.
.PP
References moeoStochTournamentSelect< MOEOT >::comparator, and moeoStochTournamentSelect< MOEOT >::tRate.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.