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

143 lines
9.5 KiB
TeX

\section{moeo\-Environmental\-Replacement$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoEnvironmentalReplacement}\index{moeoEnvironmentalReplacement@{moeoEnvironmentalReplacement}}
Environmental replacement strategy that consists in keeping the N best individuals by deleting individuals 1 by 1 and by updating the fitness and diversity values after each deletion.
{\tt \#include $<$moeo\-Environmental\-Replacement.h$>$}
Inheritance diagram for moeo\-Environmental\-Replacement$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoEnvironmentalReplacement}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef MOEOT::Objective\-Vector {\bf Objective\-Vector}\label{classmoeoEnvironmentalReplacement_ef38fb9b1ab23ddd2c558639e19f4821}
\begin{CompactList}\small\item\em The type for objective vector. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf moeo\-Environmental\-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\-Environmental\-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\-Environmental\-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\-Environmental\-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{classmoeoEnvironmentalReplacement_c6153c6660117e2be01037005e7b2f88}
\begin{CompactList}\small\item\em the fitness assignment strategy \item\end{CompactList}\item
{\bf moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \& {\bf eval\-Diversity}\label{classmoeoEnvironmentalReplacement_e6c72ca94a7e5c2785f465899c50f6a4}
\begin{CompactList}\small\item\em the diversity assignment strategy \item\end{CompactList}\item
{\bf moeo\-Comparator}$<$ MOEOT $>$ \& {\bf comparator}\label{classmoeoEnvironmentalReplacement_38bb3a80a72557537d2bfa05c51467f9}
\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\-Environmental\-Replacement$<$ MOEOT $>$}
Environmental replacement strategy that consists in keeping the N best individuals by deleting individuals 1 by 1 and by updating the fitness and diversity values after each deletion.
Definition at line 25 of file moeo\-Environmental\-Replacement.h.
\subsection{Constructor \& Destructor Documentation}
\index{moeoEnvironmentalReplacement@{moeo\-Environmental\-Replacement}!moeoEnvironmentalReplacement@{moeoEnvironmentalReplacement}}
\index{moeoEnvironmentalReplacement@{moeoEnvironmentalReplacement}!moeoEnvironmentalReplacement@{moeo\-Environmental\-Replacement}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Environmental\-Replacement}$<$ MOEOT $>$::{\bf moeo\-Environmental\-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{classmoeoEnvironmentalReplacement_ce7cbcb364cd895a26f5a4d391162646}
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 39 of file moeo\-Environmental\-Replacement.h.\index{moeoEnvironmentalReplacement@{moeo\-Environmental\-Replacement}!moeoEnvironmentalReplacement@{moeoEnvironmentalReplacement}}
\index{moeoEnvironmentalReplacement@{moeoEnvironmentalReplacement}!moeoEnvironmentalReplacement@{moeo\-Environmental\-Replacement}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Environmental\-Replacement}$<$ MOEOT $>$::{\bf moeo\-Environmental\-Replacement} ({\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \& {\em \_\-eval\-Fitness}, {\bf moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \& {\em \_\-eval\-Diversity})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoEnvironmentalReplacement_54f9aee2bfd18f1ad3df3f9373f14f57}
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 49 of file moeo\-Environmental\-Replacement.h.\index{moeoEnvironmentalReplacement@{moeo\-Environmental\-Replacement}!moeoEnvironmentalReplacement@{moeoEnvironmentalReplacement}}
\index{moeoEnvironmentalReplacement@{moeoEnvironmentalReplacement}!moeoEnvironmentalReplacement@{moeo\-Environmental\-Replacement}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Environmental\-Replacement}$<$ MOEOT $>$::{\bf moeo\-Environmental\-Replacement} ({\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \& {\em \_\-eval\-Fitness}, {\bf moeo\-Comparator}$<$ MOEOT $>$ \& {\em \_\-comparator})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoEnvironmentalReplacement_e44afd264a95693eb21daae3508c8450}
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 59 of file moeo\-Environmental\-Replacement.h.\index{moeoEnvironmentalReplacement@{moeo\-Environmental\-Replacement}!moeoEnvironmentalReplacement@{moeoEnvironmentalReplacement}}
\index{moeoEnvironmentalReplacement@{moeoEnvironmentalReplacement}!moeoEnvironmentalReplacement@{moeo\-Environmental\-Replacement}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Environmental\-Replacement}$<$ MOEOT $>$::{\bf moeo\-Environmental\-Replacement} ({\bf moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \& {\em \_\-eval\-Fitness})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoEnvironmentalReplacement_f31706a4551bb293c86713fa196d0ac0}
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 69 of file moeo\-Environmental\-Replacement.h.
\subsection{Member Function Documentation}
\index{moeoEnvironmentalReplacement@{moeo\-Environmental\-Replacement}!operator()@{operator()}}
\index{operator()@{operator()}!moeoEnvironmentalReplacement@{moeo\-Environmental\-Replacement}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void {\bf moeo\-Environmental\-Replacement}$<$ MOEOT $>$::operator() ({\bf eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-parents}, {\bf eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-offspring})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmoeoEnvironmentalReplacement_55acfca7f9dd9e3d75cef7c9015dc037}
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 79 of file moeo\-Environmental\-Replacement.h.
References moeo\-Environmental\-Replacement$<$ MOEOT $>$::comparator, moeo\-Environmental\-Replacement$<$ MOEOT $>$::eval\-Diversity, and moeo\-Environmental\-Replacement$<$ MOEOT $>$::eval\-Fitness.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Environmental\-Replacement.h\end{CompactItemize}