paradiseo/trunk/paradiseo-moeo/doc/latex/classmoeoElitistReplacement.tex
liefooga f58813fd6e doc up-to-date
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@558 331e1502-861f-0410-8da2-ba01fb791d7f
2007-07-06 07:40:50 +00:00

141 lines
9.1 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 $>$ \&\_\-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\-Elitist\-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\-Elitist\-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\-Elitist\-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{classmoeoElitistReplacement_ba390ae799848417dc41d0e71b010425}
\begin{CompactList}\small\item\em the fitness assignment strategy \item\end{CompactList}\item
\bf{moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \& \bf{diversity\-Assignment}\label{classmoeoElitistReplacement_7dff2c8d871e87a2ba326b69fd0c48d9}
\begin{CompactList}\small\item\em the diversity assignment strategy \item\end{CompactList}\item
\bf{moeo\-Dummy\-Diversity\-Assignment}$<$ MOEOT $>$ \bf{default\-Diversity}\label{classmoeoElitistReplacement_0a88fa6ae1cba0eb041b804f86e31ab2}
\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{classmoeoElitistReplacement_e4b10eae9d1b048525737fbe47e34215}
\begin{CompactList}\small\item\em a fitness then diversity comparator can be used as default \item\end{CompactList}\item
\bf{moeo\-Elitist\-Replacement::Cmp} \bf{comparator}\label{classmoeoElitistReplacement_4ef0a67b6f52c7238449522f4773ad60}
\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\-Elitist\-Replacement$<$ MOEOT $>$}
Elitist replacement strategy that consists in keeping the N best individuals.
Definition at line 26 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 \_\-fitness\-Assignment}, \bf{moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \& {\em \_\-diversity\-Assignment}, \bf{moeo\-Comparator}$<$ MOEOT $>$ \& {\em \_\-comparator})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoElitistReplacement_1d91980f3f800833c8e9452cb450ae3e}
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 36 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 \_\-fitness\-Assignment}, \bf{moeo\-Diversity\-Assignment}$<$ MOEOT $>$ \& {\em \_\-diversity\-Assignment})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoElitistReplacement_d7122be0519207c7496852284ed24514}
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 46 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 \_\-fitness\-Assignment}, \bf{moeo\-Comparator}$<$ MOEOT $>$ \& {\em \_\-comparator})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoElitistReplacement_81b7b8e0cac6cbed36e47688adf1466c}
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 56 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 \_\-fitness\-Assignment})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoElitistReplacement_2ef7c199d779d473a9d35cee21556794}
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 66 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]}}\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}
Definition at line 76 of file moeo\-Elitist\-Replacement.h.
References moeo\-Elitist\-Replacement$<$ MOEOT $>$::comparator, moeo\-Elitist\-Replacement$<$ MOEOT $>$::diversity\-Assignment, and moeo\-Elitist\-Replacement$<$ MOEOT $>$::fitness\-Assignment.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Elitist\-Replacement.h\end{CompactItemize}