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

102 lines
6.4 KiB
TeX

\section{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoFrontByFrontCrowdingDistanceDiversityAssignment}\index{moeoFrontByFrontCrowdingDistanceDiversityAssignment@{moeoFrontByFrontCrowdingDistanceDiversityAssignment}}
Diversity assignment sheme based on crowding distance proposed in: K.
{\tt \#include $<$moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment.h$>$}
Inheritance diagram for moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoFrontByFrontCrowdingDistanceDiversityAssignment}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef MOEOT::Objective\-Vector \bf{Objective\-Vector}\label{classmoeoFrontByFrontCrowdingDistanceDiversityAssignment_4da1cf7b19fd72eb9b6a64d89d01f5a3}
\begin{CompactList}\small\item\em the objective vector type of the solutions \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
void \bf{update\-By\-Deleting} (\bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop, \bf{Objective\-Vector} \&\_\-obj\-Vec)
\end{CompactItemize}
\subsection*{Private Member Functions}
\begin{CompactItemize}
\item
void \bf{set\-Distances} (\bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop)
\begin{CompactList}\small\item\em Sets the distance values. \item\end{CompactList}\item
unsigned int \bf{last\-Index} (\bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop, unsigned int \_\-start)
\begin{CompactList}\small\item\em Returns the index of the last individual having the same fitness value than \_\-pop[\_\-start]. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$}
Diversity assignment sheme based on crowding distance proposed in: K.
Deb, A. Pratap, S. Agarwal, T. Meyarivan, \char`\"{}A Fast and Elitist Multi-Objective Genetic Algorithm: NSGA-II\char`\"{}, IEEE Transactions on Evolutionary Computation, vol. 6, no. 2 (2002). Tis strategy assigns diversity values FRONT BY FRONT. It is, for instance, used in NSGA-II.
Definition at line 25 of file moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment.h.
\subsection{Member Function Documentation}
\index{moeoFrontByFrontCrowdingDistanceDiversityAssignment@{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment}!updateByDeleting@{updateByDeleting}}
\index{updateByDeleting@{updateByDeleting}!moeoFrontByFrontCrowdingDistanceDiversityAssignment@{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment}$<$ MOEOT $>$::update\-By\-Deleting (\bf{eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop}, \bf{Objective\-Vector} \& {\em \_\-obj\-Vec})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmoeoFrontByFrontCrowdingDistanceDiversityAssignment_91aec07ffdc20c9654575106399ca62d}
\begin{Desc}
\item[Warning:]NOT IMPLEMENTED, DO NOTHING ! Updates the diversity values of the whole population \_\-pop by taking the deletion of the objective vector \_\-obj\-Vec into account. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-pop}]the population \item[{\em \_\-obj\-Vec}]the objective vector \end{description}
\end{Desc}
\begin{Desc}
\item[Warning:]NOT IMPLEMENTED, DO NOTHING ! \end{Desc}
Reimplemented from \bf{moeo\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$} \doxyref{p.}{classmoeoCrowdingDistanceDiversityAssignment_ac21453d018c0e5dc872ccf0d0893f18}.
Definition at line 40 of file moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment.h.\index{moeoFrontByFrontCrowdingDistanceDiversityAssignment@{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment}!setDistances@{setDistances}}
\index{setDistances@{setDistances}!moeoFrontByFrontCrowdingDistanceDiversityAssignment@{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment}$<$ MOEOT $>$::set\-Distances (\bf{eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop})\hspace{0.3cm}{\tt [inline, private, virtual]}}\label{classmoeoFrontByFrontCrowdingDistanceDiversityAssignment_b275343fd08575612525a5654d749feb}
Sets the distance values.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-pop}]the population \end{description}
\end{Desc}
Reimplemented from \bf{moeo\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$} \doxyref{p.}{classmoeoCrowdingDistanceDiversityAssignment_2dac680d7ca8327a15bc30f5ce7bbd4f}.
Definition at line 55 of file moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment.h.
References moeo\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$::inf(), moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$::last\-Index(), and moeo\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$::tiny().\index{moeoFrontByFrontCrowdingDistanceDiversityAssignment@{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment}!lastIndex@{lastIndex}}
\index{lastIndex@{lastIndex}!moeoFrontByFrontCrowdingDistanceDiversityAssignment@{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ unsigned int \bf{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment}$<$ MOEOT $>$::last\-Index (\bf{eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop}, unsigned int {\em \_\-start})\hspace{0.3cm}{\tt [inline, private]}}\label{classmoeoFrontByFrontCrowdingDistanceDiversityAssignment_c7f75934e76d37a2747f06d2271984c3}
Returns the index of the last individual having the same fitness value than \_\-pop[\_\-start].
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-pop}]the population \item[{\em \_\-start}]the index to start from \end{description}
\end{Desc}
Definition at line 121 of file moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment.h.
Referenced by moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$::set\-Distances().
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment.h\end{CompactItemize}