paradiseo/branches/paradiseo-moeo-1.0/doc/latex/classmoeoEnvironmentalReplacement.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

147 lines
10 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 $>$ \&\_\-fitness\-Assignment, \bf{moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \&\_\-diversity\-Assignment, \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 $>$ \&\_\-fitness\-Assignment, \bf{moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \&\_\-diversity\-Assignment)
\begin{CompactList}\small\item\em Constructor without comparator. \item\end{CompactList}\item
\bf{moeo\-Environmental\-Replacement} (\bf{moeo\-Fitness\-Assignment}$<$ MOEOT $>$ \&\_\-fitness\-Assignment, \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 $>$ \&\_\-fitness\-Assignment)
\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{fitness\-Assignment}\label{classmoeoEnvironmentalReplacement_4b7bc138b17ad5381355c0481bc9c669}
\begin{CompactList}\small\item\em the fitness assignment strategy \item\end{CompactList}\item
\bf{moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \& \bf{diversity\-Assignment}\label{classmoeoEnvironmentalReplacement_e2453bd96c9a490f7de21f9ce22fdff9}
\begin{CompactList}\small\item\em the diversity assignment strategy \item\end{CompactList}\item
\bf{moeo\-Dummy\-Diversity\-Assignment}$<$ MOEOT $>$ \bf{default\-Diversity}\label{classmoeoEnvironmentalReplacement_7f546704db3225ee1c40439beff5f618}
\begin{CompactList}\small\item\em a dummy diversity assignment can be used as default \item\end{CompactList}\item
\bf{moeo\-Fitness\-Then\-Diversity\-Comparator}$<$ MOEOT $>$ \bf{default\-Comparator}\label{classmoeoEnvironmentalReplacement_b7f4ce8d3ecf2d18e8c48982875760bb}
\begin{CompactList}\small\item\em a fitness then diversity comparator can be used as default \item\end{CompactList}\item
\bf{moeo\-Environmental\-Replacement::Cmp} \bf{comparator}\label{classmoeoEnvironmentalReplacement_e3a9d75b9e6603aba4a04fb8062db0a4}
\begin{CompactList}\small\item\em this object is used to compare solutions in order to sort the population \item\end{CompactList}\end{CompactItemize}
\subsection*{Classes}
\begin{CompactItemize}
\item
class \bf{Cmp}
\begin{CompactList}\small\item\em this object 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 26 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 \_\-fitness\-Assignment}, \bf{moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \& {\em \_\-diversity\-Assignment}, \bf{moeo\-Comparator}$<$ MOEOT $>$ \& {\em \_\-comparator})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoEnvironmentalReplacement_de6e8f546a4583f1eee31366f7099c38}
Full constructor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-fitness\-Assignment}]the fitness assignment strategy \item[{\em \_\-diversity\-Assignment}]the diversity assignment strategy \item[{\em \_\-comparator}]the comparator (used to compare 2 individuals) \end{description}
\end{Desc}
Definition at line 40 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 \_\-fitness\-Assignment}, \bf{moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \& {\em \_\-diversity\-Assignment})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoEnvironmentalReplacement_9199a29cf89cd6b01bb9be304f344940}
Constructor without comparator.
A moeo\-Fit\-Then\-Div\-Comparator is used as default. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-fitness\-Assignment}]the fitness assignment strategy \item[{\em \_\-diversity\-Assignment}]the diversity assignment strategy \end{description}
\end{Desc}
Definition at line 50 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 \_\-fitness\-Assignment}, \bf{moeo\-Comparator}$<$ MOEOT $>$ \& {\em \_\-comparator})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoEnvironmentalReplacement_7512641b5d58c96a148a75fd4dc95bf7}
Constructor without moeo\-Diversity\-Assignement.
A dummy diversity is used as default. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-fitness\-Assignment}]the fitness assignment strategy \item[{\em \_\-comparator}]the comparator (used to compare 2 individuals) \end{description}
\end{Desc}
Definition at line 60 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 \_\-fitness\-Assignment})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoEnvironmentalReplacement_2dfa5d51660039b4f90196e7885ed586}
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 \_\-fitness\-Assignment}]the fitness assignment strategy \end{description}
\end{Desc}
Definition at line 70 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]}}\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}
Definition at line 80 of file moeo\-Environmental\-Replacement.h.
References moeo\-Environmental\-Replacement$<$ MOEOT $>$::comparator, moeo\-Environmental\-Replacement$<$ MOEOT $>$::diversity\-Assignment, and moeo\-Environmental\-Replacement$<$ MOEOT $>$::fitness\-Assignment.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Environmental\-Replacement.h\end{CompactItemize}