paradiseo/trunk/paradiseo-moeo/docs/man/man3/moeoDetTournamentSelect.3
liefooga 2e7e817428 update docs
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@263 331e1502-861f-0410-8da2-ba01fb791d7f
2007-04-17 15:45:01 +00:00

103 lines
2.8 KiB
Groff

.TH "moeoDetTournamentSelect" 3 "17 Apr 2007" "Version 1.0.alpha" "ParadisEO-MOEO" \" -*- nroff -*-
.ad l
.nh
.SH NAME
moeoDetTournamentSelect \- Selection strategy that selects ONE individual by deterministic tournament.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <moeoDetTournamentSelect.h>\fP
.PP
Inherits \fBmoeoSelectOne< MOEOT >< MOEOT >\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBmoeoDetTournamentSelect\fP (\fBmoeoComparator\fP< MOEOT > &_comparator, unsigned _tSize=2)"
.br
.RI "\fIFull Ctor. \fP"
.ti -1c
.RI "\fBmoeoDetTournamentSelect\fP (unsigned _tSize=2)"
.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 "unsigned \fBtSize\fP"
.br
.RI "\fIthe number of individuals in the tournament \fP"
.in -1c
.SH "Detailed Description"
.PP
.SS "template<class MOEOT> class moeoDetTournamentSelect< MOEOT >"
Selection strategy that selects ONE individual by deterministic tournament.
.PP
Definition at line 23 of file moeoDetTournamentSelect.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "template<class MOEOT> \fBmoeoDetTournamentSelect\fP< MOEOT >::\fBmoeoDetTournamentSelect\fP (\fBmoeoComparator\fP< MOEOT > & _comparator, unsigned _tSize = \fC2\fP)\fC [inline]\fP"
.PP
Full Ctor.
.PP
\fBParameters:\fP
.RS 4
\fI_comparator\fP the comparator (used to compare 2 individuals)
.br
\fI_tSize\fP the number of individuals in the tournament (default: 2)
.RE
.PP
.PP
Definition at line 33 of file moeoDetTournamentSelect.h.
.PP
References moeoDetTournamentSelect< MOEOT >::tSize.
.SS "template<class MOEOT> \fBmoeoDetTournamentSelect\fP< MOEOT >::\fBmoeoDetTournamentSelect\fP (unsigned _tSize = \fC2\fP)\fC [inline]\fP"
.PP
Ctor without comparator.
.PP
A \fBmoeoFitnessThenDiversityComparator\fP is used as default.
.PP
\fBParameters:\fP
.RS 4
\fI_tSize\fP the number of individuals in the tournament (default: 2)
.RE
.PP
.PP
Definition at line 50 of file moeoDetTournamentSelect.h.
.PP
References moeoDetTournamentSelect< MOEOT >::tSize.
.SH "Member Function Documentation"
.PP
.SS "template<class MOEOT> const MOEOT& \fBmoeoDetTournamentSelect\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 68 of file moeoDetTournamentSelect.h.
.PP
References moeoDetTournamentSelect< MOEOT >::comparator, and moeoDetTournamentSelect< MOEOT >::tSize.
.SH "Author"
.PP
Generated automatically by Doxygen for ParadisEO-MOEO from the source code.