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

178 lines
10 KiB
TeX

\section{moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoSharingDiversityAssignment}\index{moeoSharingDiversityAssignment@{moeoSharingDiversityAssignment}}
Sharing assignment scheme originally porposed by: D.
{\tt \#include $<$moeo\-Sharing\-Diversity\-Assignment.h$>$}
Inheritance diagram for moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoSharingDiversityAssignment}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef MOEOT::Objective\-Vector \bf{Objective\-Vector}\label{classmoeoSharingDiversityAssignment_5e92f136f41363dcb8a6df94dbf2f3b3}
\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\-Sharing\-Diversity\-Assignment} (\bf{moeo\-Distance}$<$ MOEOT, double $>$ \&\_\-distance, double \_\-niche\-Size=0.5, double \_\-alpha=1.0)
\begin{CompactList}\small\item\em Ctor. \item\end{CompactList}\item
\bf{moeo\-Sharing\-Diversity\-Assignment} (double \_\-niche\-Size=0.5, double \_\-alpha=1.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{operator()} (\bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop)
\begin{CompactList}\small\item\em Sets 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\-Similarities} (\bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop)
\begin{CompactList}\small\item\em Sets similarities for every solution contained in the population \_\-pop. \item\end{CompactList}\item
double \bf{sh} (double \_\-dist)
\begin{CompactList}\small\item\em Sharing function. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item
\bf{moeo\-Distance}$<$ MOEOT, double $>$ \& \bf{distance}\label{classmoeoSharingDiversityAssignment_b81d950d0469ebd4c769994bcea58f8b}
\begin{CompactList}\small\item\em the distance used to compute the neighborhood of solutions \item\end{CompactList}\item
\bf{moeo\-Euclidean\-Distance}$<$ MOEOT $>$ \bf{default\-Distance}\label{classmoeoSharingDiversityAssignment_ecde6f1a0ba15d9ec563396a585188f0}
\begin{CompactList}\small\item\em euclidean distancein the objective space (can be used as default) \item\end{CompactList}\item
double \bf{niche\-Size}\label{classmoeoSharingDiversityAssignment_175d978d4b56603a3bcb45fec8395441}
\begin{CompactList}\small\item\em neighborhood size in terms of radius distance \item\end{CompactList}\item
double \bf{alpha}\label{classmoeoSharingDiversityAssignment_95ed49448a35d5b99cdfd496a33fd45b}
\begin{CompactList}\small\item\em parameter used to regulate the shape of the sharing function \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$}
Sharing assignment scheme originally porposed by: D.
E. Goldberg, \char`\"{}Genetic Algorithms in Search, Optimization and Machine Learning\char`\"{}, Addision-Wesley, MA, USA (1989).
Definition at line 28 of file moeo\-Sharing\-Diversity\-Assignment.h.
\subsection{Constructor \& Destructor Documentation}
\index{moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}!moeoSharingDiversityAssignment@{moeoSharingDiversityAssignment}}
\index{moeoSharingDiversityAssignment@{moeoSharingDiversityAssignment}!moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ \bf{moeo\-Sharing\-Diversity\-Assignment}$<$ MOEOT $>$::\bf{moeo\-Sharing\-Diversity\-Assignment} (\bf{moeo\-Distance}$<$ MOEOT, double $>$ \& {\em \_\-distance}, double {\em \_\-niche\-Size} = {\tt 0.5}, double {\em \_\-alpha} = {\tt 1.0})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoSharingDiversityAssignment_10ba0d2cdd57ce47244afdf4b1623409}
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 42 of file moeo\-Sharing\-Diversity\-Assignment.h.\index{moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}!moeoSharingDiversityAssignment@{moeoSharingDiversityAssignment}}
\index{moeoSharingDiversityAssignment@{moeoSharingDiversityAssignment}!moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ \bf{moeo\-Sharing\-Diversity\-Assignment}$<$ MOEOT $>$::\bf{moeo\-Sharing\-Diversity\-Assignment} (double {\em \_\-niche\-Size} = {\tt 0.5}, double {\em \_\-alpha} = {\tt 1.0})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoSharingDiversityAssignment_ccc66529da0cacd3f11a019ebe646668}
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 51 of file moeo\-Sharing\-Diversity\-Assignment.h.
\subsection{Member Function Documentation}
\index{moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}!operator()@{operator()}}
\index{operator()@{operator()}!moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-Sharing\-Diversity\-Assignment}$<$ MOEOT $>$::operator() (\bf{eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmoeoSharingDiversityAssignment_6228be85e166172cf03def1a004505d5}
Sets 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 59 of file moeo\-Sharing\-Diversity\-Assignment.h.
References moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::set\-Similarities().\index{moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}!updateByDeleting@{updateByDeleting}}
\index{updateByDeleting@{updateByDeleting}!moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-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{classmoeoSharingDiversityAssignment_21c8d6e020af23b2be219b7e02248300}
\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\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$} \doxyref{p.}{classmoeoFrontByFrontSharingDiversityAssignment_623489a246f86cf24cc5860d32caa743}.
Definition at line 80 of file moeo\-Sharing\-Diversity\-Assignment.h.\index{moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}!setSimilarities@{setSimilarities}}
\index{setSimilarities@{setSimilarities}!moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ virtual void \bf{moeo\-Sharing\-Diversity\-Assignment}$<$ MOEOT $>$::set\-Similarities (\bf{eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop})\hspace{0.3cm}{\tt [inline, protected, virtual]}}\label{classmoeoSharingDiversityAssignment_c01f6ac1abba3799f5c4b6c0608dac55}
Sets similarities for every solution contained in the population \_\-pop.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-pop}]the population \end{description}
\end{Desc}
Reimplemented in \bf{moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$} \doxyref{p.}{classmoeoFrontByFrontSharingDiversityAssignment_a0f6c045237aba2857c4a9ec25679e69}.
Definition at line 102 of file moeo\-Sharing\-Diversity\-Assignment.h.
References moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::distance, and moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::sh().
Referenced by moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::operator()().\index{moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}!sh@{sh}}
\index{sh@{sh}!moeoSharingDiversityAssignment@{moeo\-Sharing\-Diversity\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ double \bf{moeo\-Sharing\-Diversity\-Assignment}$<$ MOEOT $>$::sh (double {\em \_\-dist})\hspace{0.3cm}{\tt [inline, protected]}}\label{classmoeoSharingDiversityAssignment_5b5daaa55e97c6fcd172d61c7837e26c}
Sharing function.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-dist}]the distance value \end{description}
\end{Desc}
Definition at line 125 of file moeo\-Sharing\-Diversity\-Assignment.h.
References moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::alpha, and moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::niche\-Size.
Referenced by moeo\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::set\-Similarities(), and moeo\-Front\-By\-Front\-Sharing\-Diversity\-Assignment$<$ MOEOT $>$::set\-Similarities().
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Sharing\-Diversity\-Assignment.h\end{CompactItemize}