paradiseo/trunk/paradiseo-moeo/docs/latex/classmoeoObjectiveVectorTraits.tex
liefooga 2e7e817428 update docs
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@263 331e1502-861f-0410-8da2-ba01fb791d7f
2007-04-17 15:45:01 +00:00

96 lines
4.5 KiB
TeX

\section{moeo\-Objective\-Vector\-Traits Class Reference}
\label{classmoeoObjectiveVectorTraits}\index{moeoObjectiveVectorTraits@{moeoObjectiveVectorTraits}}
A traits class for \doxyref{moeo\-Objective\-Vector}{p.}{classmoeoObjectiveVector} to specify the number of objectives and which ones have to be minimized or maximized.
{\tt \#include $<$moeo\-Objective\-Vector\-Traits.h$>$}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item
static void {\bf setup} (unsigned \_\-n\-Objectives, std::vector$<$ bool $>$ \&\_\-b\-Objectives)
\begin{CompactList}\small\item\em Parameters setting. \item\end{CompactList}\item
static unsigned {\bf n\-Objectives} ()\label{classmoeoObjectiveVectorTraits_b7b3047536f5ba2f7d0da3f19b00f4d3}
\begin{CompactList}\small\item\em Returns the number of objectives. \item\end{CompactList}\item
static bool {\bf minimizing} (unsigned \_\-i)
\begin{CompactList}\small\item\em Returns true if the \_\-ith objective have to be minimized. \item\end{CompactList}\item
static bool {\bf maximizing} (unsigned \_\-i)
\begin{CompactList}\small\item\em Returns true if the \_\-ith objective have to be maximized. \item\end{CompactList}\item
static double {\bf tolerance} ()\label{classmoeoObjectiveVectorTraits_c1199e4f019ec88a0365db81e9ab8d1f}
\begin{CompactList}\small\item\em Returns the tolerance value (to compare solutions). \item\end{CompactList}\end{CompactItemize}
\subsection*{Static Private Attributes}
\begin{CompactItemize}
\item
static unsigned {\bf n\-Obj}\label{classmoeoObjectiveVectorTraits_cac944804ce067ae62ca9b6bc139db03}
\begin{CompactList}\small\item\em The number of objectives. \item\end{CompactList}\item
static std::vector$<$ bool $>$ {\bf b\-Obj}\label{classmoeoObjectiveVectorTraits_db329d416c75711f671c9d7cffb06299}
\begin{CompactList}\small\item\em The min/max vector. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
A traits class for \doxyref{moeo\-Objective\-Vector}{p.}{classmoeoObjectiveVector} to specify the number of objectives and which ones have to be minimized or maximized.
Definition at line 23 of file moeo\-Objective\-Vector\-Traits.h.
\subsection{Member Function Documentation}
\index{moeoObjectiveVectorTraits@{moeo\-Objective\-Vector\-Traits}!setup@{setup}}
\index{setup@{setup}!moeoObjectiveVectorTraits@{moeo\-Objective\-Vector\-Traits}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static void moeo\-Objective\-Vector\-Traits::setup (unsigned {\em \_\-n\-Objectives}, std::vector$<$ bool $>$ \& {\em \_\-b\-Objectives})\hspace{0.3cm}{\tt [inline, static]}}\label{classmoeoObjectiveVectorTraits_52264fa9e700c4ff183dd90f6965d9fc}
Parameters setting.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-n\-Objectives}]the number of objectives \item[{\em \_\-b\-Objectives}]the min/max vector (true = min / false = max) \end{description}
\end{Desc}
Definition at line 32 of file moeo\-Objective\-Vector\-Traits.h.
References b\-Obj, and n\-Obj.\index{moeoObjectiveVectorTraits@{moeo\-Objective\-Vector\-Traits}!minimizing@{minimizing}}
\index{minimizing@{minimizing}!moeoObjectiveVectorTraits@{moeo\-Objective\-Vector\-Traits}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static bool moeo\-Objective\-Vector\-Traits::minimizing (unsigned {\em \_\-i})\hspace{0.3cm}{\tt [inline, static]}}\label{classmoeoObjectiveVectorTraits_5cb7975e5ea32809e01b7078313d326d}
Returns true if the \_\-ith objective have to be minimized.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-i}]the index \end{description}
\end{Desc}
Definition at line 65 of file moeo\-Objective\-Vector\-Traits.h.
References b\-Obj.
Referenced by maximizing().\index{moeoObjectiveVectorTraits@{moeo\-Objective\-Vector\-Traits}!maximizing@{maximizing}}
\index{maximizing@{maximizing}!moeoObjectiveVectorTraits@{moeo\-Objective\-Vector\-Traits}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}static bool moeo\-Objective\-Vector\-Traits::maximizing (unsigned {\em \_\-i})\hspace{0.3cm}{\tt [inline, static]}}\label{classmoeoObjectiveVectorTraits_b76148b68b28d41600065b9d82e815b5}
Returns true if the \_\-ith objective have to be maximized.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-i}]the index \end{description}
\end{Desc}
Definition at line 77 of file moeo\-Objective\-Vector\-Traits.h.
References minimizing().
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Objective\-Vector\-Traits.h\end{CompactItemize}