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

114 lines
6.5 KiB
TeX

\section{moeo\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoCrowdingDistanceDiversityAssignment}\index{moeoCrowdingDistanceDiversityAssignment@{moeoCrowdingDistanceDiversityAssignment}}
Diversity assignment sheme based on crowding distance proposed in: K.
{\tt \#include $<$moeo\-Crowding\-Distance\-Diversity\-Assignment.h$>$}
Inheritance diagram for moeo\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoCrowdingDistanceDiversityAssignment}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef MOEOT::Objective\-Vector \bf{Objective\-Vector}\label{classmoeoCrowdingDistanceDiversityAssignment_7c5b1b763bf82e2d557586533b072a64}
\begin{CompactList}\small\item\em the objective vector type of the solutions \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
double \bf{inf} () const \label{classmoeoCrowdingDistanceDiversityAssignment_fd3720297b90f97b38996a4db24632f8}
\begin{CompactList}\small\item\em Returns a big value (regarded as infinite). \item\end{CompactList}\item
double \bf{tiny} () const \label{classmoeoCrowdingDistanceDiversityAssignment_9ed112968bb30897e14c675a33046cf8}
\begin{CompactList}\small\item\em Returns a very small value that can be used to avoid extreme cases (where the min bound == the max bound). \item\end{CompactList}\item
void \bf{operator()} (\bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop)
\begin{CompactList}\small\item\em Computes diversity values for every solution contained in the population \_\-pop. \item\end{CompactList}\item
void \bf{update\-By\-Deleting} (\bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop, \bf{Objective\-Vector} \&\_\-obj\-Vec)
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item
virtual void \bf{set\-Distances} (\bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop)
\begin{CompactList}\small\item\em Sets the distance values. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-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).
Definition at line 25 of file moeo\-Crowding\-Distance\-Diversity\-Assignment.h.
\subsection{Member Function Documentation}
\index{moeoCrowdingDistanceDiversityAssignment@{moeo\-Crowding\-Distance\-Diversity\-Assignment}!operator()@{operator()}}
\index{operator()@{operator()}!moeoCrowdingDistanceDiversityAssignment@{moeo\-Crowding\-Distance\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-Crowding\-Distance\-Diversity\-Assignment}$<$ MOEOT $>$::operator() (\bf{eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmoeoCrowdingDistanceDiversityAssignment_7af5b14f4a0d288fd12fa6044b816c54}
Computes diversity values for every solution contained in the population \_\-pop.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-pop}]the population \end{description}
\end{Desc}
Implements \bf{eo\-UF$<$ eo\-Pop$<$ MOEOT $>$ \&, void $>$}.
Definition at line 55 of file moeo\-Crowding\-Distance\-Diversity\-Assignment.h.
References moeo\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$::inf(), and moeo\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$::set\-Distances().\index{moeoCrowdingDistanceDiversityAssignment@{moeo\-Crowding\-Distance\-Diversity\-Assignment}!updateByDeleting@{updateByDeleting}}
\index{updateByDeleting@{updateByDeleting}!moeoCrowdingDistanceDiversityAssignment@{moeo\-Crowding\-Distance\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-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{classmoeoCrowdingDistanceDiversityAssignment_ac21453d018c0e5dc872ccf0d0893f18}
\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}
Implements \bf{moeo\-Diversity\-Assignment$<$ MOEOT $>$} \doxyref{p.}{classmoeoDiversityAssignment_57f400263b36664df6269f1b522cfdcb}.
Reimplemented in \bf{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$} \doxyref{p.}{classmoeoFrontByFrontCrowdingDistanceDiversityAssignment_91aec07ffdc20c9654575106399ca62d}.
Definition at line 78 of file moeo\-Crowding\-Distance\-Diversity\-Assignment.h.\index{moeoCrowdingDistanceDiversityAssignment@{moeo\-Crowding\-Distance\-Diversity\-Assignment}!setDistances@{setDistances}}
\index{setDistances@{setDistances}!moeoCrowdingDistanceDiversityAssignment@{moeo\-Crowding\-Distance\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ virtual void \bf{moeo\-Crowding\-Distance\-Diversity\-Assignment}$<$ MOEOT $>$::set\-Distances (\bf{eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop})\hspace{0.3cm}{\tt [inline, protected, virtual]}}\label{classmoeoCrowdingDistanceDiversityAssignment_2dac680d7ca8327a15bc30f5ce7bbd4f}
Sets the distance values.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-pop}]the population \end{description}
\end{Desc}
Reimplemented in \bf{moeo\-Front\-By\-Front\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$} \doxyref{p.}{classmoeoFrontByFrontCrowdingDistanceDiversityAssignment_b275343fd08575612525a5654d749feb}.
Definition at line 90 of file moeo\-Crowding\-Distance\-Diversity\-Assignment.h.
References moeo\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$::inf().
Referenced by moeo\-Crowding\-Distance\-Diversity\-Assignment$<$ MOEOT $>$::operator()().
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Crowding\-Distance\-Diversity\-Assignment.h\end{CompactItemize}