paradiseo/trunk/paradiseo-moeo/doc/latex/classmoeoAchievementFitnessAssignment.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

172 lines
9.9 KiB
TeX

\section{moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoAchievementFitnessAssignment}\index{moeoAchievementFitnessAssignment@{moeoAchievementFitnessAssignment}}
Fitness assignment sheme based on the achievement scalarizing function propozed by Wiersbicki (1980).
{\tt \#include $<$moeo\-Achievement\-Fitness\-Assignment.h$>$}
Inheritance diagram for moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5cm]{classmoeoAchievementFitnessAssignment}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef MOEOT::Objective\-Vector \bf{Objective\-Vector}\label{classmoeoAchievementFitnessAssignment_1a58a88ff0175cf303eb63d8b4f52a26}
\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\-Achievement\-Fitness\-Assignment} (\bf{Objective\-Vector} \&\_\-reference, std::vector$<$ double $>$ \&\_\-lambdas, double \_\-spn=0.0001)
\begin{CompactList}\small\item\em Default ctor. \item\end{CompactList}\item
\bf{moeo\-Achievement\-Fitness\-Assignment} (\bf{Objective\-Vector} \&\_\-reference, double \_\-spn=0.0001)
\begin{CompactList}\small\item\em Ctor with default values for lambdas (1/n\-Objectives). \item\end{CompactList}\item
virtual void \bf{operator()} (\bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop)
\begin{CompactList}\small\item\em Sets the fitness 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)
\begin{CompactList}\small\item\em Updates the fitness values of the whole population \_\-pop by taking the deletion of the objective vector \_\-obj\-Vec into account (nothing to do). \item\end{CompactList}\item
void \bf{set\-Reference} (const \bf{Objective\-Vector} \&\_\-reference)
\begin{CompactList}\small\item\em Sets the reference point. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Member Functions}
\begin{CompactItemize}
\item
double \bf{inf} () const \label{classmoeoAchievementFitnessAssignment_cdc77cfe1180bc792b9de82755828896}
\begin{CompactList}\small\item\em Returns a big value (regarded as infinite). \item\end{CompactList}\item
void \bf{compute} (MOEOT \&\_\-moeo)
\begin{CompactList}\small\item\em Computes the fitness value for a solution. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
\bf{Objective\-Vector} \bf{reference}\label{classmoeoAchievementFitnessAssignment_3f01cc20823b53f440dd1ab5a82c3564}
\begin{CompactList}\small\item\em the reference point \item\end{CompactList}\item
std::vector$<$ double $>$ \bf{lambdas}\label{classmoeoAchievementFitnessAssignment_2992fb7c43286bef9cd6dc7628fa083a}
\begin{CompactList}\small\item\em the weighted coefficients vector \item\end{CompactList}\item
double \bf{spn}\label{classmoeoAchievementFitnessAssignment_bf99cd0c85e298bdd1281ef2fb06e7b0}
\begin{CompactList}\small\item\em an arbitrary small positive number (0 $<$ \_\-spn $<$$<$ 1) \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$}
Fitness assignment sheme based on the achievement scalarizing function propozed by Wiersbicki (1980).
Definition at line 24 of file moeo\-Achievement\-Fitness\-Assignment.h.
\subsection{Constructor \& Destructor Documentation}
\index{moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}!moeoAchievementFitnessAssignment@{moeoAchievementFitnessAssignment}}
\index{moeoAchievementFitnessAssignment@{moeoAchievementFitnessAssignment}!moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ \bf{moeo\-Achievement\-Fitness\-Assignment}$<$ MOEOT $>$::\bf{moeo\-Achievement\-Fitness\-Assignment} (\bf{Objective\-Vector} \& {\em \_\-reference}, std::vector$<$ double $>$ \& {\em \_\-lambdas}, double {\em \_\-spn} = {\tt 0.0001})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoAchievementFitnessAssignment_52ae7d8112e66813232172a26d03cbb8}
Default ctor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-reference}]reference point vector \item[{\em \_\-lambdas}]weighted coefficients vector \item[{\em \_\-spn}]arbitrary small positive number (0 $<$ \_\-spn $<$$<$ 1) \end{description}
\end{Desc}
Definition at line 38 of file moeo\-Achievement\-Fitness\-Assignment.h.
References moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$::spn.\index{moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}!moeoAchievementFitnessAssignment@{moeoAchievementFitnessAssignment}}
\index{moeoAchievementFitnessAssignment@{moeoAchievementFitnessAssignment}!moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ \bf{moeo\-Achievement\-Fitness\-Assignment}$<$ MOEOT $>$::\bf{moeo\-Achievement\-Fitness\-Assignment} (\bf{Objective\-Vector} \& {\em \_\-reference}, double {\em \_\-spn} = {\tt 0.0001})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoAchievementFitnessAssignment_75d9668a256381ef764352d705dcf47a}
Ctor with default values for lambdas (1/n\-Objectives).
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-reference}]reference point vector \item[{\em \_\-spn}]arbitrary small positive number (0 $<$ \_\-spn $<$$<$ 1) \end{description}
\end{Desc}
Definition at line 54 of file moeo\-Achievement\-Fitness\-Assignment.h.
References moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$::lambdas, and moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$::spn.
\subsection{Member Function Documentation}
\index{moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}!operator()@{operator()}}
\index{operator()@{operator()}!moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ virtual void \bf{moeo\-Achievement\-Fitness\-Assignment}$<$ MOEOT $>$::operator() (\bf{eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmoeoAchievementFitnessAssignment_d5863db9571d7f23a16ca184adf562a3}
Sets the fitness 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 75 of file moeo\-Achievement\-Fitness\-Assignment.h.
References moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$::compute().\index{moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}!updateByDeleting@{updateByDeleting}}
\index{updateByDeleting@{updateByDeleting}!moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-Achievement\-Fitness\-Assignment}$<$ MOEOT $>$::update\-By\-Deleting (\bf{eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop}, \bf{Objective\-Vector} \& {\em \_\-obj\-Vec})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmoeoAchievementFitnessAssignment_a6a2ae6c263dbcea3c16cde4c8a1e5fc}
Updates the fitness values of the whole population \_\-pop by taking the deletion of the objective vector \_\-obj\-Vec into account (nothing to do).
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-pop}]the population \item[{\em \_\-obj\-Vec}]the objective vector \end{description}
\end{Desc}
Implements \bf{moeo\-Fitness\-Assignment$<$ MOEOT $>$} \doxyref{p.}{classmoeoFitnessAssignment_4922629569eddc9be049b3ead1ab0269}.
Definition at line 89 of file moeo\-Achievement\-Fitness\-Assignment.h.\index{moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}!setReference@{setReference}}
\index{setReference@{setReference}!moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-Achievement\-Fitness\-Assignment}$<$ MOEOT $>$::set\-Reference (const \bf{Objective\-Vector} \& {\em \_\-reference})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoAchievementFitnessAssignment_d200530e3fbdf847dca970ac2265d83d}
Sets the reference point.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-reference}]the new reference point \end{description}
\end{Desc}
Definition at line 99 of file moeo\-Achievement\-Fitness\-Assignment.h.
References moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$::reference.\index{moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}!compute@{compute}}
\index{compute@{compute}!moeoAchievementFitnessAssignment@{moeo\-Achievement\-Fitness\-Assignment}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-Achievement\-Fitness\-Assignment}$<$ MOEOT $>$::compute (MOEOT \& {\em \_\-moeo})\hspace{0.3cm}{\tt [inline, private]}}\label{classmoeoAchievementFitnessAssignment_7c027540ed0d7f61559f636b6b8a4b29}
Computes the fitness value for a solution.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-moeo}]the solution \end{description}
\end{Desc}
Definition at line 128 of file moeo\-Achievement\-Fitness\-Assignment.h.
References moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$::inf(), moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$::lambdas, moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$::reference, and moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$::spn.
Referenced by moeo\-Achievement\-Fitness\-Assignment$<$ MOEOT $>$::operator()().
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Achievement\-Fitness\-Assignment.h\end{CompactItemize}