update docs

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@263 331e1502-861f-0410-8da2-ba01fb791d7f

trunk/paradiseo-moeo/docs/latex/classmoeoGDominanceObjectiveVectorComparator.tex

@@ -0,0 +1,104 @@
+\section{moeo\-GDominance\-Objective\-Vector\-Comparator$<$ Objective\-Vector $>$ Class Template Reference}
+\label{classmoeoGDominanceObjectiveVectorComparator}\index{moeoGDominanceObjectiveVectorComparator@{moeoGDominanceObjectiveVectorComparator}}
+This functor class allows to compare 2 objective vectors according to g-dominance.  
+
+
+{\tt \#include $<$moeo\-Objective\-Vector\-Comparator.h$>$}
+
+Inheritance diagram for moeo\-GDominance\-Objective\-Vector\-Comparator$<$ Objective\-Vector $>$::\begin{figure}[H]
+\begin{center}
+\leavevmode
+\includegraphics[height=4cm]{classmoeoGDominanceObjectiveVectorComparator}
+\end{center}
+\end{figure}
+\subsection*{Public Member Functions}
+\begin{CompactItemize}
+\item 
+{\bf moeo\-GDominance\-Objective\-Vector\-Comparator} (Objective\-Vector \_\-ref)
+\begin{CompactList}\small\item\em Ctor. \item\end{CompactList}\item 
+bool {\bf operator()} (const Objective\-Vector \&\_\-objective\-Vector1, const Objective\-Vector \&\_\-objective\-Vector2)
+\begin{CompactList}\small\item\em Returns true if \_\-objective\-Vector1 g-dominates \_\-objective\-Vector2. \item\end{CompactList}\end{CompactItemize}
+\subsection*{Private Member Functions}
+\begin{CompactItemize}
+\item 
+unsigned {\bf flag} (const Objective\-Vector \&\_\-objective\-Vector)
+\begin{CompactList}\small\item\em Returns the flag of \_\-objective\-Vector according to the reference point. \item\end{CompactList}\end{CompactItemize}
+\subsection*{Private Attributes}
+\begin{CompactItemize}
+\item 
+Objective\-Vector {\bf ref}\label{classmoeoGDominanceObjectiveVectorComparator_55abecc05f8768dda29695c0aff608db}
+
+\begin{CompactList}\small\item\em the reference point \item\end{CompactList}\item 
+{\bf moeo\-Pareto\-Objective\-Vector\-Comparator}$<$ Objective\-Vector $>$ {\bf pareto\-Comparator}\label{classmoeoGDominanceObjectiveVectorComparator_5768e6444e546f1da2f36ccabcfc1f70}
+
+\begin{CompactList}\small\item\em Pareto comparator. \item\end{CompactList}\end{CompactItemize}
+
+
+\subsection{Detailed Description}
+\subsubsection*{template$<$class Objective\-Vector$>$ class moeo\-GDominance\-Objective\-Vector\-Comparator$<$ Objective\-Vector $>$}
+
+This functor class allows to compare 2 objective vectors according to g-dominance. 
+
+The concept of g-dominance as been introduced in: J. Molina, L. V. Santana, A. G. Hernandez-Diaz, C. A. Coello Coello, R. Caballero, \char`\"{}g-dominance: Reference point based dominance\char`\"{} (2007) 
+
+
+
+Definition at line 88 of file moeo\-Objective\-Vector\-Comparator.h.
+
+\subsection{Constructor \& Destructor Documentation}
+\index{moeoGDominanceObjectiveVectorComparator@{moeo\-GDominance\-Objective\-Vector\-Comparator}!moeoGDominanceObjectiveVectorComparator@{moeoGDominanceObjectiveVectorComparator}}
+\index{moeoGDominanceObjectiveVectorComparator@{moeoGDominanceObjectiveVectorComparator}!moeoGDominanceObjectiveVectorComparator@{moeo\-GDominance\-Objective\-Vector\-Comparator}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector$>$ {\bf moeo\-GDominance\-Objective\-Vector\-Comparator}$<$ Objective\-Vector $>$::{\bf moeo\-GDominance\-Objective\-Vector\-Comparator} (Objective\-Vector {\em \_\-ref})\hspace{0.3cm}{\tt  [inline]}}\label{classmoeoGDominanceObjectiveVectorComparator_3eb8db7f05eabcd94ec96a3bc5fe48ae}
+
+
+Ctor. 
+
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em \_\-ref}]the reference point \end{description}
+\end{Desc}
+
+
+Definition at line 96 of file moeo\-Objective\-Vector\-Comparator.h.
+
+\subsection{Member Function Documentation}
+\index{moeoGDominanceObjectiveVectorComparator@{moeo\-GDominance\-Objective\-Vector\-Comparator}!operator()@{operator()}}
+\index{operator()@{operator()}!moeoGDominanceObjectiveVectorComparator@{moeo\-GDominance\-Objective\-Vector\-Comparator}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector$>$ bool {\bf moeo\-GDominance\-Objective\-Vector\-Comparator}$<$ Objective\-Vector $>$::operator() (const Objective\-Vector \& {\em \_\-objective\-Vector1}, const Objective\-Vector \& {\em \_\-objective\-Vector2})\hspace{0.3cm}{\tt  [inline]}}\label{classmoeoGDominanceObjectiveVectorComparator_e2714bd3b21e027801ca84943e846e88}
+
+
+Returns true if \_\-objective\-Vector1 g-dominates \_\-objective\-Vector2. 
+
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em \_\-objective\-Vector1}]the first objective vector \item[{\em \_\-objective\-Vector2}]the second objective vector \end{description}
+\end{Desc}
+
+
+Definition at line 105 of file moeo\-Objective\-Vector\-Comparator.h.
+
+References moeo\-GDominance\-Objective\-Vector\-Comparator$<$ Objective\-Vector $>$::flag(), and moeo\-GDominance\-Objective\-Vector\-Comparator$<$ Objective\-Vector $>$::pareto\-Comparator.\index{moeoGDominanceObjectiveVectorComparator@{moeo\-GDominance\-Objective\-Vector\-Comparator}!flag@{flag}}
+\index{flag@{flag}!moeoGDominanceObjectiveVectorComparator@{moeo\-GDominance\-Objective\-Vector\-Comparator}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector$>$ unsigned {\bf moeo\-GDominance\-Objective\-Vector\-Comparator}$<$ Objective\-Vector $>$::flag (const Objective\-Vector \& {\em \_\-objective\-Vector})\hspace{0.3cm}{\tt  [inline, private]}}\label{classmoeoGDominanceObjectiveVectorComparator_7095866316c7f03940d22ca4b4175b7b}
+
+
+Returns the flag of \_\-objective\-Vector according to the reference point. 
+
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em \_\-objective\-Vector}]the first objective vector \end{description}
+\end{Desc}
+
+
+Definition at line 139 of file moeo\-Objective\-Vector\-Comparator.h.
+
+References moeo\-GDominance\-Objective\-Vector\-Comparator$<$ Objective\-Vector $>$::ref.
+
+Referenced by moeo\-GDominance\-Objective\-Vector\-Comparator$<$ Objective\-Vector $>$::operator()().
+
+The documentation for this class was generated from the following file:\begin{CompactItemize}
+\item 
+moeo\-Objective\-Vector\-Comparator.h\end{CompactItemize}