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

137 lines
8.6 KiB
TeX

\section{moeo\-Elitist\-Replacement$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoElitistReplacement}\index{moeoElitistReplacement@{moeoElitistReplacement}}
Elitist replacement strategy that consists in keeping the N best individuals.
{\tt \#include $<$moeo\-Elitist\-Replacement.h$>$}
Inheritance diagram for moeo\-Elitist\-Replacement$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoElitistReplacement}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf moeo\-Elitist\-Replacement} ({\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \&\_\-eval\-Fitness, {\bf moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \&\_\-eval\-Diversity, {\bf moeo\-Comparator}$<$ MOEOT $>$ \&\_\-comparator)
\begin{CompactList}\small\item\em Full constructor. \item\end{CompactList}\item
{\bf moeo\-Elitist\-Replacement} ({\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \&\_\-eval\-Fitness, {\bf moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \&\_\-eval\-Diversity)
\begin{CompactList}\small\item\em Constructor without comparator. \item\end{CompactList}\item
{\bf moeo\-Elitist\-Replacement} ({\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \&\_\-eval\-Fitness, {\bf moeo\-Comparator}$<$ MOEOT $>$ \&\_\-comparator)
\begin{CompactList}\small\item\em Constructor without moeo\-Diversity\-Assignement. \item\end{CompactList}\item
{\bf moeo\-Elitist\-Replacement} ({\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \&\_\-eval\-Fitness)
\begin{CompactList}\small\item\em Constructor without moeo\-Diversity\-Assignement nor \doxyref{moeo\-Comparator}{p.}{classmoeoComparator}. \item\end{CompactList}\item
void {\bf operator()} ({\bf eo\-Pop}$<$ MOEOT $>$ \&\_\-parents, {\bf eo\-Pop}$<$ MOEOT $>$ \&\_\-offspring)
\begin{CompactList}\small\item\em Replaces the first population by adding the individuals of the second one, sorting with a \doxyref{moeo\-Comparator}{p.}{classmoeoComparator} and resizing the whole population obtained. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item
{\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \& {\bf eval\-Fitness}\label{classmoeoElitistReplacement_caefe4d041453d2a5fb8ccedc5c9e351}
\begin{CompactList}\small\item\em the fitness assignment strategy \item\end{CompactList}\item
{\bf moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \& {\bf eval\-Diversity}\label{classmoeoElitistReplacement_52ba3396f1d95337486b29a6a997c7c3}
\begin{CompactList}\small\item\em the diversity assignment strategy \item\end{CompactList}\item
{\bf moeo\-Comparator}$<$ MOEOT $>$ \& {\bf comparator}\label{classmoeoElitistReplacement_642ddf2bf5d556b20d2bdddeaab9e968}
\begin{CompactList}\small\item\em the comparator (used to compare 2 individuals) \item\end{CompactList}\end{CompactItemize}
\subsection*{Classes}
\begin{CompactItemize}
\item
class {\bf Cmp}
\begin{CompactList}\small\item\em This class is used to compare solutions in order to sort the population. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Elitist\-Replacement$<$ MOEOT $>$}
Elitist replacement strategy that consists in keeping the N best individuals.
Definition at line 24 of file moeo\-Elitist\-Replacement.h.
\subsection{Constructor \& Destructor Documentation}
\index{moeoElitistReplacement@{moeo\-Elitist\-Replacement}!moeoElitistReplacement@{moeoElitistReplacement}}
\index{moeoElitistReplacement@{moeoElitistReplacement}!moeoElitistReplacement@{moeo\-Elitist\-Replacement}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Elitist\-Replacement}$<$ MOEOT $>$::{\bf moeo\-Elitist\-Replacement} ({\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \& {\em \_\-eval\-Fitness}, {\bf moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \& {\em \_\-eval\-Diversity}, {\bf moeo\-Comparator}$<$ MOEOT $>$ \& {\em \_\-comparator})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoElitistReplacement_76d642bc51aef42444a01cd0f54832e2}
Full constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-eval\-Fitness}]the fitness assignment strategy \item[{\em \_\-eval\-Diversity}]the diversity assignment strategy \item[{\em \_\-comparator}]the comparator (used to compare 2 individuals) \end{description}
\end{Desc}
Definition at line 34 of file moeo\-Elitist\-Replacement.h.\index{moeoElitistReplacement@{moeo\-Elitist\-Replacement}!moeoElitistReplacement@{moeoElitistReplacement}}
\index{moeoElitistReplacement@{moeoElitistReplacement}!moeoElitistReplacement@{moeo\-Elitist\-Replacement}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Elitist\-Replacement}$<$ MOEOT $>$::{\bf moeo\-Elitist\-Replacement} ({\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \& {\em \_\-eval\-Fitness}, {\bf moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \& {\em \_\-eval\-Diversity})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoElitistReplacement_755797c869d35fdeb3467cb13faabb39}
Constructor without comparator.
A moeo\-Fit\-Then\-Div\-Comparator is used as default. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-eval\-Fitness}]the fitness assignment strategy \item[{\em \_\-eval\-Diversity}]the diversity assignment strategy \end{description}
\end{Desc}
Definition at line 44 of file moeo\-Elitist\-Replacement.h.\index{moeoElitistReplacement@{moeo\-Elitist\-Replacement}!moeoElitistReplacement@{moeoElitistReplacement}}
\index{moeoElitistReplacement@{moeoElitistReplacement}!moeoElitistReplacement@{moeo\-Elitist\-Replacement}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Elitist\-Replacement}$<$ MOEOT $>$::{\bf moeo\-Elitist\-Replacement} ({\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \& {\em \_\-eval\-Fitness}, {\bf moeo\-Comparator}$<$ MOEOT $>$ \& {\em \_\-comparator})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoElitistReplacement_edb91a2a6450cc8da01b98da631d11ce}
Constructor without moeo\-Diversity\-Assignement.
A dummy diversity is used as default. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-eval\-Fitness}]the fitness assignment strategy \item[{\em \_\-comparator}]the comparator (used to compare 2 individuals) \end{description}
\end{Desc}
Definition at line 54 of file moeo\-Elitist\-Replacement.h.\index{moeoElitistReplacement@{moeo\-Elitist\-Replacement}!moeoElitistReplacement@{moeoElitistReplacement}}
\index{moeoElitistReplacement@{moeoElitistReplacement}!moeoElitistReplacement@{moeo\-Elitist\-Replacement}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Elitist\-Replacement}$<$ MOEOT $>$::{\bf moeo\-Elitist\-Replacement} ({\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \& {\em \_\-eval\-Fitness})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoElitistReplacement_782c45dbc5d077b96db4f08b808488df}
Constructor without moeo\-Diversity\-Assignement nor \doxyref{moeo\-Comparator}{p.}{classmoeoComparator}.
A moeo\-Fit\-Then\-Div\-Comparator and a dummy diversity are used as default. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-eval\-Fitness}]the fitness assignment strategy \end{description}
\end{Desc}
Definition at line 64 of file moeo\-Elitist\-Replacement.h.
\subsection{Member Function Documentation}
\index{moeoElitistReplacement@{moeo\-Elitist\-Replacement}!operator()@{operator()}}
\index{operator()@{operator()}!moeoElitistReplacement@{moeo\-Elitist\-Replacement}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void {\bf moeo\-Elitist\-Replacement}$<$ MOEOT $>$::operator() ({\bf eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-parents}, {\bf eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-offspring})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmoeoElitistReplacement_0364c6ef9d16f7eb65caa9edfce69006}
Replaces the first population by adding the individuals of the second one, sorting with a \doxyref{moeo\-Comparator}{p.}{classmoeoComparator} and resizing the whole population obtained.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-parents}]the population composed of the parents (the population you want to replace) \item[{\em \_\-offspring}]the offspring population \end{description}
\end{Desc}
Implements {\bf eo\-BF$<$ eo\-Pop$<$ MOEOT $>$ \&, eo\-Pop$<$ MOEOT $>$ \&, void $>$}.
Definition at line 74 of file moeo\-Elitist\-Replacement.h.
References moeo\-Elitist\-Replacement$<$ MOEOT $>$::comparator, moeo\-Elitist\-Replacement$<$ MOEOT $>$::eval\-Diversity, and moeo\-Elitist\-Replacement$<$ MOEOT $>$::eval\-Fitness.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Elitist\-Replacement.h\end{CompactItemize}