paradiseo/trunk/paradiseo-moeo/doc/latex/classmoeoFrontByFrontSharingDiversityAssignment.tex
liefooga 8b7d5260fb merge ParadisEO-MOEO v-1.0
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@400 331e1502-861f-0410-8da2-ba01fb791d7f
2007-06-26 13:28:59 +00:00

117 lines
7.7 KiB
TeX

\section{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoFrontByFrontSharingDiversityAssignment}\index{moeoFrontByFrontSharingDiversityAssignment@{moeoFrontByFrontSharingDiversityAssignment}}
Sharing assignment scheme on the way it is used in NSGA.
{\tt \#include $<$moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment.h$>$}
Inheritance diagram for moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoFrontByFrontSharingDiversityAssignment}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef MOEOT::Objective\-Vector \bf{Objective\-Vector}\label{classmoeoFrontByFrontSharingDiversityAssignment_c5350ba4340adea240c9cb362c1eb96d}
\begin{CompactList}\small\item\em the objective vector type of the solutions \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
\bf{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment} (\bf{moeo\-Distance}$<$ MOEOT, double $>$ \&\_\-distance, double \_\-niche\-Size=0.5, double \_\-alpha=2.0)
\begin{CompactList}\small\item\em Ctor. \item\end{CompactList}\item
\bf{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment} (double \_\-niche\-Size=0.5, double \_\-alpha=2.0)
\begin{CompactList}\small\item\em Ctor with an euclidean distance (with normalized objective values) in the objective space is used as default. \item\end{CompactList}\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\-Similarities} (\bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop)
\begin{CompactList}\small\item\em Sets similarities FRONT BY FRONT for every solution contained in the population \_\-pop. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$}
Sharing assignment scheme on the way it is used in NSGA.
Definition at line 22 of file moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment.h.
\subsection{Constructor \& Destructor Documentation}
\index{moeoFrontByFrontSharingDiversityAssignment@{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment}!moeoFrontByFrontSharingDiversityAssignment@{moeoFrontByFrontSharingDiversityAssignment}}
\index{moeoFrontByFrontSharingDiversityAssignment@{moeoFrontByFrontSharingDiversityAssignment}!moeoFrontByFrontSharingDiversityAssignment@{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ \bf{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment}$<$ MOEOT $>$::\bf{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment} (\bf{moeo\-Distance}$<$ MOEOT, double $>$ \& {\em \_\-distance}, double {\em \_\-niche\-Size} = {\tt 0.5}, double {\em \_\-alpha} = {\tt 2.0})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoFrontByFrontSharingDiversityAssignment_a77c641d3d9184f60c3aace07fb1774f}
Ctor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-distance}]the distance used to compute the neighborhood of solutions (can be related to the decision space or the objective space) \item[{\em \_\-niche\-Size}]neighborhood size in terms of radius distance (closely related to the way the distances are computed) \item[{\em \_\-alpha}]parameter used to regulate the shape of the sharing function \end{description}
\end{Desc}
Definition at line 36 of file moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment.h.\index{moeoFrontByFrontSharingDiversityAssignment@{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment}!moeoFrontByFrontSharingDiversityAssignment@{moeoFrontByFrontSharingDiversityAssignment}}
\index{moeoFrontByFrontSharingDiversityAssignment@{moeoFrontByFrontSharingDiversityAssignment}!moeoFrontByFrontSharingDiversityAssignment@{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ \bf{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment}$<$ MOEOT $>$::\bf{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment} (double {\em \_\-niche\-Size} = {\tt 0.5}, double {\em \_\-alpha} = {\tt 2.0})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoFrontByFrontSharingDiversityAssignment_fec74d6b140ff6bb98e80ca13d57b6d7}
Ctor with an euclidean distance (with normalized objective values) in the objective space is used as default.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-niche\-Size}]neighborhood size in terms of radius distance (closely related to the way the distances are computed) \item[{\em \_\-alpha}]parameter used to regulate the shape of the sharing function \end{description}
\end{Desc}
Definition at line 45 of file moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment.h.
\subsection{Member Function Documentation}
\index{moeoFrontByFrontSharingDiversityAssignment@{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment}!updateByDeleting@{updateByDeleting}}
\index{updateByDeleting@{updateByDeleting}!moeoFrontByFrontSharingDiversityAssignment@{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-Front\-By\-Front\-Sharing\-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{classmoeoFrontByFrontSharingDiversityAssignment_623489a246f86cf24cc5860d32caa743}
\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\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$} \doxyref{p.}{classmoeoSharingDiversityAssignment_21c8d6e020af23b2be219b7e02248300}.
Definition at line 56 of file moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment.h.\index{moeoFrontByFrontSharingDiversityAssignment@{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment}!setSimilarities@{setSimilarities}}
\index{setSimilarities@{setSimilarities}!moeoFrontByFrontSharingDiversityAssignment@{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment}$<$ MOEOT $>$::set\-Similarities (\bf{eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop})\hspace{0.3cm}{\tt [inline, private, virtual]}}\label{classmoeoFrontByFrontSharingDiversityAssignment_a0f6c045237aba2857c4a9ec25679e69}
Sets similarities FRONT BY FRONT for every solution contained in the population \_\-pop.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-pop}]the population \end{description}
\end{Desc}
Reimplemented from \bf{moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$} \doxyref{p.}{classmoeoSharingDiversityAssignment_c01f6ac1abba3799f5c4b6c0608dac55}.
Definition at line 74 of file moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment.h.
References moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::distance, moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::niche\-Size, and moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::sh().
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment.h\end{CompactItemize}