paradiseo/trunk/paradiseo-eo/doc/latex/classeo_select_many.tex
legrand c3aec878e5 Paradiseo-eo sources added
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
2006-12-12 14:49:08 +00:00

72 lines
3.2 KiB
TeX

\section{eo\-Select\-Many$<$ EOT $>$ Class Template Reference}
\label{classeo_select_many}\index{eoSelectMany@{eoSelectMany}}
eo\-Select\-Many selects many individuals using {\bf eo\-Select\-One}{\rm (p.\,\pageref{classeo_select_one})} as it's mechanism.
{\tt \#include $<$eo\-Select\-Many.h$>$}
Inheritance diagram for eo\-Select\-Many$<$ EOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.75184cm]{classeo_select_many}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf eo\-Select\-Many} ({\bf eo\-Select\-One}$<$ {\bf EOT} $>$ \&\_\-select, double \_\-rate, bool \_\-interpret\_\-as\_\-rate=true)\label{classeo_select_many_a0}
\begin{CompactList}\small\item\em init \item\end{CompactList}\item
{\bf eo\-Select\-Many} ({\bf eo\-Select\-One}$<$ {\bf EOT} $>$ \&\_\-select, {\bf eo\-How\-Many} \_\-how\-Many)\label{classeo_select_many_a1}
\item
virtual void {\bf operator()} (const {\bf eo\-Pop}$<$ {\bf EOT} $>$ \&\_\-source, {\bf eo\-Pop}$<$ {\bf EOT} $>$ \&\_\-dest)
\begin{CompactList}\small\item\em The implementation repeatidly selects an individual. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
{\bf eo\-Select\-One}$<$ {\bf EOT} $>$ \& {\bf select}\label{classeo_select_many_r0}
\item
{\bf eo\-How\-Many} {\bf how\-Many}\label{classeo_select_many_r1}
\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class EOT$>$ class eo\-Select\-Many$<$ EOT $>$}
eo\-Select\-Many selects many individuals using {\bf eo\-Select\-One}{\rm (p.\,\pageref{classeo_select_one})} as it's mechanism.
Therefore eo\-Select\-Many needs an {\bf eo\-Select\-One}{\rm (p.\,\pageref{classeo_select_one})} in its ctor
It will use an eo\-How\-Mnay to determine the number of guys to select, and push them to the back of the destination population.
Definition at line 45 of file eo\-Select\-Many.h.
\subsection{Member Function Documentation}
\index{eoSelectMany@{eo\-Select\-Many}!operator()@{operator()}}
\index{operator()@{operator()}!eoSelectMany@{eo\-Select\-Many}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ virtual void {\bf eo\-Select\-Many}$<$ {\bf EOT} $>$::operator() (const {\bf eo\-Pop}$<$ {\bf EOT} $>$ \& {\em \_\-source}, {\bf eo\-Pop}$<$ {\bf EOT} $>$ \& {\em \_\-dest})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classeo_select_many_a2}
The implementation repeatidly selects an individual.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-source}]the source population \item[{\em \_\-dest}]the resulting population (size of this population is the number of times {\bf eo\-Select\-One}{\rm (p.\,\pageref{classeo_select_one})} is called. It empties the destination and adds the selection into it) \end{description}
\end{Desc}
Implements {\bf eo\-BF$<$ const eo\-Pop$<$ EOT $>$ \&, eo\-Pop$<$ EOT $>$ \&, void $>$} {\rm (p.\,\pageref{classeo_b_f_a1})}.
Definition at line 63 of file eo\-Select\-Many.h.
References eo\-Select\-One$<$ EOT, Worth\-T $>$::setup().
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
eo\-Select\-Many.h\end{CompactItemize}