paradiseo/branches/paradiseo-moeo-1.0/doc/latex/classmoeoSelectFromPopAndArch.tex
liefooga b1d6dd41c0 add doc
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@397 331e1502-861f-0410-8da2-ba01fb791d7f
2007-06-26 13:13:33 +00:00

89 lines
5.6 KiB
TeX

\section{moeo\-Select\-From\-Pop\-And\-Arch$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoSelectFromPopAndArch}\index{moeoSelectFromPopAndArch@{moeoSelectFromPopAndArch}}
Elitist selection process that consists in choosing individuals in the archive as well as in the current population.
{\tt \#include $<$moeo\-Select\-From\-Pop\-And\-Arch.h$>$}
Inheritance diagram for moeo\-Select\-From\-Pop\-And\-Arch$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoSelectFromPopAndArch}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
\bf{moeo\-Select\-From\-Pop\-And\-Arch} (\bf{moeo\-Select\-One}$<$ MOEOT $>$ \&\_\-pop\-Select\-One, \bf{moeo\-Select\-One}$<$ MOEOT $>$ \_\-arch\-Select\-One, \bf{moeo\-Archive}$<$ MOEOT $>$ \&\_\-arch, double \_\-ratio\-From\-Pop=0.5)
\begin{CompactList}\small\item\em Ctor. \item\end{CompactList}\item
\bf{moeo\-Select\-From\-Pop\-And\-Arch} (\bf{moeo\-Select\-One}$<$ MOEOT $>$ \&\_\-pop\-Select\-One, \bf{moeo\-Archive}$<$ MOEOT $>$ \&\_\-arch, double \_\-ratio\-From\-Pop=0.5)
\begin{CompactList}\small\item\em Defaulr ctor - the archive's selection operator is a random selector. \item\end{CompactList}\item
virtual const MOEOT \& \bf{operator()} (const \bf{eo\-Pop}$<$ MOEOT $>$ \&pop)\label{classmoeoSelectFromPopAndArch_7b763aef8e25f205159b69b3f746c942}
\begin{CompactList}\small\item\em The selection process. \item\end{CompactList}\item
virtual void \bf{setup} (const \bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop)\label{classmoeoSelectFromPopAndArch_70180aeaa5d647a720276c82b7a0b111}
\begin{CompactList}\small\item\em Setups some population stats. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
\bf{moeo\-Select\-One}$<$ MOEOT $>$ \& \bf{pop\-Select\-One}\label{classmoeoSelectFromPopAndArch_e16fb61bf9c115b0a34528e512d30ac6}
\begin{CompactList}\small\item\em The population's selection operator. \item\end{CompactList}\item
\bf{moeo\-Select\-One}$<$ MOEOT $>$ \& \bf{arch\-Select\-One}\label{classmoeoSelectFromPopAndArch_a34f3871b3a9f94614a15c381c2fa570}
\begin{CompactList}\small\item\em The archive's selection operator. \item\end{CompactList}\item
\bf{moeo\-Archive}$<$ MOEOT $>$ \& \bf{arch}\label{classmoeoSelectFromPopAndArch_e87de22341f2225ea94ee2895a7eb4a6}
\begin{CompactList}\small\item\em The archive. \item\end{CompactList}\item
double \bf{ratio\-From\-Pop}\label{classmoeoSelectFromPopAndArch_78a1e18111b46c447c86a0f77484d970}
\begin{CompactList}\small\item\em The ratio of selected individuals from the population. \item\end{CompactList}\item
\bf{moeo\-Random\-Select}$<$ MOEOT $>$ \bf{random\-Select\-One}\label{classmoeoSelectFromPopAndArch_d6094492eed214e3bdb0330620a5890a}
\begin{CompactList}\small\item\em A random selection operator (used as default for arch\-Select\-One). \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Select\-From\-Pop\-And\-Arch$<$ MOEOT $>$}
Elitist selection process that consists in choosing individuals in the archive as well as in the current population.
Definition at line 26 of file moeo\-Select\-From\-Pop\-And\-Arch.h.
\subsection{Constructor \& Destructor Documentation}
\index{moeoSelectFromPopAndArch@{moeo\-Select\-From\-Pop\-And\-Arch}!moeoSelectFromPopAndArch@{moeoSelectFromPopAndArch}}
\index{moeoSelectFromPopAndArch@{moeoSelectFromPopAndArch}!moeoSelectFromPopAndArch@{moeo\-Select\-From\-Pop\-And\-Arch}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ \bf{moeo\-Select\-From\-Pop\-And\-Arch}$<$ MOEOT $>$::\bf{moeo\-Select\-From\-Pop\-And\-Arch} (\bf{moeo\-Select\-One}$<$ MOEOT $>$ \& {\em \_\-pop\-Select\-One}, \bf{moeo\-Select\-One}$<$ MOEOT $>$ {\em \_\-arch\-Select\-One}, \bf{moeo\-Archive}$<$ MOEOT $>$ \& {\em \_\-arch}, double {\em \_\-ratio\-From\-Pop} = {\tt 0.5})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoSelectFromPopAndArch_96b34f67d678a7df7610f28bf10c4e86}
Ctor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-pop\-Select\-One}]the population's selection operator \item[{\em \_\-arch\-Select\-One}]the archive's selection operator \item[{\em \_\-arch}]the archive \item[{\em \_\-ratio\-From\-Pop}]the ratio of selected individuals from the population \end{description}
\end{Desc}
Definition at line 37 of file moeo\-Select\-From\-Pop\-And\-Arch.h.\index{moeoSelectFromPopAndArch@{moeo\-Select\-From\-Pop\-And\-Arch}!moeoSelectFromPopAndArch@{moeoSelectFromPopAndArch}}
\index{moeoSelectFromPopAndArch@{moeoSelectFromPopAndArch}!moeoSelectFromPopAndArch@{moeo\-Select\-From\-Pop\-And\-Arch}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ \bf{moeo\-Select\-From\-Pop\-And\-Arch}$<$ MOEOT $>$::\bf{moeo\-Select\-From\-Pop\-And\-Arch} (\bf{moeo\-Select\-One}$<$ MOEOT $>$ \& {\em \_\-pop\-Select\-One}, \bf{moeo\-Archive}$<$ MOEOT $>$ \& {\em \_\-arch}, double {\em \_\-ratio\-From\-Pop} = {\tt 0.5})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoSelectFromPopAndArch_1c225b5f7b5a5ce6e87b46a7ea4a4cd0}
Defaulr ctor - the archive's selection operator is a random selector.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-pop\-Select\-One}]the population's selection operator \item[{\em \_\-arch}]the archive \item[{\em \_\-ratio\-From\-Pop}]the ratio of selected individuals from the population \end{description}
\end{Desc}
Definition at line 48 of file moeo\-Select\-From\-Pop\-And\-Arch.h.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Select\-From\-Pop\-And\-Arch.h\end{CompactItemize}