paradiseo/trunk/paradiseo-moeo/docs/latex/classmoeoDetTournamentSelect.tex
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

99 lines
4.8 KiB
TeX

\section{moeo\-Det\-Tournament\-Select$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoDetTournamentSelect}\index{moeoDetTournamentSelect@{moeoDetTournamentSelect}}
Selection strategy that selects ONE individual by deterministic tournament.
{\tt \#include $<$moeo\-Det\-Tournament\-Select.h$>$}
Inheritance diagram for moeo\-Det\-Tournament\-Select$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoDetTournamentSelect}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf moeo\-Det\-Tournament\-Select} ({\bf moeo\-Comparator}$<$ MOEOT $>$ \&\_\-comparator, unsigned \_\-t\-Size=2)
\begin{CompactList}\small\item\em Full Ctor. \item\end{CompactList}\item
{\bf moeo\-Det\-Tournament\-Select} (unsigned \_\-t\-Size=2)
\begin{CompactList}\small\item\em Ctor without comparator. \item\end{CompactList}\item
const MOEOT \& {\bf operator()} (const {\bf eo\-Pop}$<$ MOEOT $>$ \&\_\-pop)
\begin{CompactList}\small\item\em Apply the tournament to the given population. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item
{\bf moeo\-Comparator}$<$ MOEOT $>$ \& {\bf comparator}\label{classmoeoDetTournamentSelect_f31a46190da0fe561d748133456907c9}
\begin{CompactList}\small\item\em the comparator (used to compare 2 individuals) \item\end{CompactList}\item
unsigned {\bf t\-Size}\label{classmoeoDetTournamentSelect_459c0c0bae805db8bc93ec7c5b217e20}
\begin{CompactList}\small\item\em the number of individuals in the tournament \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Det\-Tournament\-Select$<$ MOEOT $>$}
Selection strategy that selects ONE individual by deterministic tournament.
Definition at line 23 of file moeo\-Det\-Tournament\-Select.h.
\subsection{Constructor \& Destructor Documentation}
\index{moeoDetTournamentSelect@{moeo\-Det\-Tournament\-Select}!moeoDetTournamentSelect@{moeoDetTournamentSelect}}
\index{moeoDetTournamentSelect@{moeoDetTournamentSelect}!moeoDetTournamentSelect@{moeo\-Det\-Tournament\-Select}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Det\-Tournament\-Select}$<$ MOEOT $>$::{\bf moeo\-Det\-Tournament\-Select} ({\bf moeo\-Comparator}$<$ MOEOT $>$ \& {\em \_\-comparator}, unsigned {\em \_\-t\-Size} = {\tt 2})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoDetTournamentSelect_51de6c436f95d13f70e399d00dbf895a}
Full Ctor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-comparator}]the comparator (used to compare 2 individuals) \item[{\em \_\-t\-Size}]the number of individuals in the tournament (default: 2) \end{description}
\end{Desc}
Definition at line 33 of file moeo\-Det\-Tournament\-Select.h.
References moeo\-Det\-Tournament\-Select$<$ MOEOT $>$::t\-Size.\index{moeoDetTournamentSelect@{moeo\-Det\-Tournament\-Select}!moeoDetTournamentSelect@{moeoDetTournamentSelect}}
\index{moeoDetTournamentSelect@{moeoDetTournamentSelect}!moeoDetTournamentSelect@{moeo\-Det\-Tournament\-Select}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Det\-Tournament\-Select}$<$ MOEOT $>$::{\bf moeo\-Det\-Tournament\-Select} (unsigned {\em \_\-t\-Size} = {\tt 2})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoDetTournamentSelect_27599d6d31d0d7730bc604f9bb167887}
Ctor without comparator.
A \doxyref{moeo\-Fitness\-Then\-Diversity\-Comparator}{p.}{classmoeoFitnessThenDiversityComparator} is used as default. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-t\-Size}]the number of individuals in the tournament (default: 2) \end{description}
\end{Desc}
Definition at line 50 of file moeo\-Det\-Tournament\-Select.h.
References moeo\-Det\-Tournament\-Select$<$ MOEOT $>$::t\-Size.
\subsection{Member Function Documentation}
\index{moeoDetTournamentSelect@{moeo\-Det\-Tournament\-Select}!operator()@{operator()}}
\index{operator()@{operator()}!moeoDetTournamentSelect@{moeo\-Det\-Tournament\-Select}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ const MOEOT\& {\bf moeo\-Det\-Tournament\-Select}$<$ MOEOT $>$::operator() (const {\bf eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoDetTournamentSelect_0d7051a48570e5dcbe9a19b90e4be3bf}
Apply the tournament to the given population.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-pop}]the population \end{description}
\end{Desc}
Definition at line 68 of file moeo\-Det\-Tournament\-Select.h.
References moeo\-Det\-Tournament\-Select$<$ MOEOT $>$::comparator, and moeo\-Det\-Tournament\-Select$<$ MOEOT $>$::t\-Size.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Det\-Tournament\-Select.h\end{CompactItemize}