paradiseo/trunk/paradiseo-moeo/docs/latex/classmoeoStochTournamentSelect.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\-Stoch\-Tournament\-Select$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoStochTournamentSelect}\index{moeoStochTournamentSelect@{moeoStochTournamentSelect}}
Selection strategy that selects ONE individual by stochastic tournament.
{\tt \#include $<$moeo\-Stoch\-Tournament\-Select.h$>$}
Inheritance diagram for moeo\-Stoch\-Tournament\-Select$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoStochTournamentSelect}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf moeo\-Stoch\-Tournament\-Select} ({\bf moeo\-Comparator}$<$ MOEOT $>$ \&\_\-comparator, double \_\-t\-Rate=1.0)
\begin{CompactList}\small\item\em Full Ctor. \item\end{CompactList}\item
{\bf moeo\-Stoch\-Tournament\-Select} (double \_\-t\-Rate=1.0)
\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{classmoeoStochTournamentSelect_a8ae24cb50092cc77872a447b6602009}
\begin{CompactList}\small\item\em the diversity assignment strategy \item\end{CompactList}\item
double {\bf t\-Rate}\label{classmoeoStochTournamentSelect_659d064e1333ee9a3e9808a15a2f53f6}
\begin{CompactList}\small\item\em the tournament rate \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Stoch\-Tournament\-Select$<$ MOEOT $>$}
Selection strategy that selects ONE individual by stochastic tournament.
Definition at line 22 of file moeo\-Stoch\-Tournament\-Select.h.
\subsection{Constructor \& Destructor Documentation}
\index{moeoStochTournamentSelect@{moeo\-Stoch\-Tournament\-Select}!moeoStochTournamentSelect@{moeoStochTournamentSelect}}
\index{moeoStochTournamentSelect@{moeoStochTournamentSelect}!moeoStochTournamentSelect@{moeo\-Stoch\-Tournament\-Select}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Stoch\-Tournament\-Select}$<$ MOEOT $>$::{\bf moeo\-Stoch\-Tournament\-Select} ({\bf moeo\-Comparator}$<$ MOEOT $>$ \& {\em \_\-comparator}, double {\em \_\-t\-Rate} = {\tt 1.0})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoStochTournamentSelect_dfd4eb2c6d148fd3cab2fb670ae7f1d4}
Full Ctor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-comparator}]the comparator (used to compare 2 individuals) \item[{\em \_\-t\-Rate}]the tournament rate \end{description}
\end{Desc}
Definition at line 31 of file moeo\-Stoch\-Tournament\-Select.h.
References moeo\-Stoch\-Tournament\-Select$<$ MOEOT $>$::t\-Rate.\index{moeoStochTournamentSelect@{moeo\-Stoch\-Tournament\-Select}!moeoStochTournamentSelect@{moeoStochTournamentSelect}}
\index{moeoStochTournamentSelect@{moeoStochTournamentSelect}!moeoStochTournamentSelect@{moeo\-Stoch\-Tournament\-Select}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Stoch\-Tournament\-Select}$<$ MOEOT $>$::{\bf moeo\-Stoch\-Tournament\-Select} (double {\em \_\-t\-Rate} = {\tt 1.0})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoStochTournamentSelect_a7d9a735f65193a943ca2cdce780e80d}
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\-Rate}]the tournament rate \end{description}
\end{Desc}
Definition at line 54 of file moeo\-Stoch\-Tournament\-Select.h.
References moeo\-Stoch\-Tournament\-Select$<$ MOEOT $>$::t\-Rate.
\subsection{Member Function Documentation}
\index{moeoStochTournamentSelect@{moeo\-Stoch\-Tournament\-Select}!operator()@{operator()}}
\index{operator()@{operator()}!moeoStochTournamentSelect@{moeo\-Stoch\-Tournament\-Select}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ const MOEOT\& {\bf moeo\-Stoch\-Tournament\-Select}$<$ MOEOT $>$::operator() (const {\bf eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoStochTournamentSelect_2323cbf99554b37dc3724c8ea26e52c1}
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 79 of file moeo\-Stoch\-Tournament\-Select.h.
References moeo\-Stoch\-Tournament\-Select$<$ MOEOT $>$::comparator, and moeo\-Stoch\-Tournament\-Select$<$ MOEOT $>$::t\-Rate.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Stoch\-Tournament\-Select.h\end{CompactItemize}