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

81 lines
3.7 KiB
TeX

\section{moeo\-Roulette\-Select$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoRouletteSelect}\index{moeoRouletteSelect@{moeoRouletteSelect}}
Selection strategy that selects ONE individual by using roulette wheel process.
{\tt \#include $<$moeo\-Roulette\-Select.h$>$}
Inheritance diagram for moeo\-Roulette\-Select$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoRouletteSelect}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf moeo\-Roulette\-Select} ({\bf moeo\-Comparator}$<$ MOEOT $>$ \&\_\-comparator, unsigned \_\-t\-Size=2)
\begin{CompactList}\small\item\em Full Ctor. \item\end{CompactList}\item
{\bf moeo\-Roulette\-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)\label{classmoeoRouletteSelect_573fe156daf6fdfbae96d2b54a9fc260}
\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{classmoeoRouletteSelect_a2dafb4d5de06b734f6ca8b62e9fc081}
\begin{CompactList}\small\item\em comparator \item\end{CompactList}\item
double \& {\bf t\-Size}\label{classmoeoRouletteSelect_19af84fe966381cbfbe032f69ee0b42b}
\begin{CompactList}\small\item\em size \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Roulette\-Select$<$ MOEOT $>$}
Selection strategy that selects ONE individual by using roulette wheel process.
Definition at line 23 of file moeo\-Roulette\-Select.h.
\subsection{Constructor \& Destructor Documentation}
\index{moeoRouletteSelect@{moeo\-Roulette\-Select}!moeoRouletteSelect@{moeoRouletteSelect}}
\index{moeoRouletteSelect@{moeoRouletteSelect}!moeoRouletteSelect@{moeo\-Roulette\-Select}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Roulette\-Select}$<$ MOEOT $>$::{\bf moeo\-Roulette\-Select} ({\bf moeo\-Comparator}$<$ MOEOT $>$ \& {\em \_\-comparator}, unsigned {\em \_\-t\-Size} = {\tt 2})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoRouletteSelect_8d5d046fd3520bee76789f3f78a732e8}
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\-Roulette\-Select.h.
References moeo\-Roulette\-Select$<$ MOEOT $>$::t\-Size.\index{moeoRouletteSelect@{moeo\-Roulette\-Select}!moeoRouletteSelect@{moeoRouletteSelect}}
\index{moeoRouletteSelect@{moeoRouletteSelect}!moeoRouletteSelect@{moeo\-Roulette\-Select}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Roulette\-Select}$<$ MOEOT $>$::{\bf moeo\-Roulette\-Select} (unsigned {\em \_\-t\-Size} = {\tt 2})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoRouletteSelect_491b8a06df1c743f78feaf01f63a2b48}
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\-Roulette\-Select.h.
References moeo\-Roulette\-Select$<$ MOEOT $>$::t\-Size.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Roulette\-Select.h\end{CompactItemize}