8b7d5260fb
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@400 331e1502-861f-0410-8da2-ba01fb791d7f
114 lines
6.2 KiB
TeX
114 lines
6.2 KiB
TeX
\section{moeo\-Objective\-Vector$<$ Objective\-Vector\-Traits, Objective\-Vector\-Type $>$ Class Template Reference}
|
|
\label{classmoeoObjectiveVector}\index{moeoObjectiveVector@{moeoObjectiveVector}}
|
|
Abstract class allowing to represent a solution in the objective space (phenotypic representation).
|
|
|
|
|
|
{\tt \#include $<$moeo\-Objective\-Vector.h$>$}
|
|
|
|
\subsection*{Public Types}
|
|
\begin{CompactItemize}
|
|
\item
|
|
typedef Objective\-Vector\-Traits \bf{Traits}\label{classmoeoObjectiveVector_21ee0475420b613951b96a550e814fbb}
|
|
|
|
\begin{CompactList}\small\item\em The traits of objective vectors. \item\end{CompactList}\item
|
|
typedef Objective\-Vector\-Type \bf{Type}\label{classmoeoObjectiveVector_e86f199692cae43bc346be63130eb993}
|
|
|
|
\begin{CompactList}\small\item\em The type of an objective value. \item\end{CompactList}\end{CompactItemize}
|
|
\subsection*{Public Member Functions}
|
|
\begin{CompactItemize}
|
|
\item
|
|
\bf{moeo\-Objective\-Vector} (\bf{Type} \_\-value=\bf{Type}())\label{classmoeoObjectiveVector_084e9d2cecbf9ea66e4b68537457109f}
|
|
|
|
\begin{CompactList}\small\item\em Ctor. \item\end{CompactList}\item
|
|
\bf{moeo\-Objective\-Vector} (std::vector$<$ \bf{Type} $>$ \&\_\-v)
|
|
\begin{CompactList}\small\item\em Ctor from a vector of Type. \item\end{CompactList}\end{CompactItemize}
|
|
\subsection*{Static Public Member Functions}
|
|
\begin{CompactItemize}
|
|
\item
|
|
static void \bf{setup} (unsigned int \_\-n\-Objectives, std::vector$<$ bool $>$ \&\_\-b\-Objectives)
|
|
\begin{CompactList}\small\item\em \doxyref{Parameters} setting (for the objective vector of any solution). \item\end{CompactList}\item
|
|
static unsigned int \bf{n\-Objectives} ()\label{classmoeoObjectiveVector_4c9a17116e0a95b4e3191f299e10fc9d}
|
|
|
|
\begin{CompactList}\small\item\em Returns the number of objectives. \item\end{CompactList}\item
|
|
static bool \bf{minimizing} (unsigned int \_\-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 int \_\-i)
|
|
\begin{CompactList}\small\item\em Returns true if the \_\-ith objective have to be maximized. \item\end{CompactList}\end{CompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
\subsubsection*{template$<$class Objective\-Vector\-Traits, class Objective\-Vector\-Type$>$ class moeo\-Objective\-Vector$<$ Objective\-Vector\-Traits, Objective\-Vector\-Type $>$}
|
|
|
|
Abstract class allowing to represent a solution in the objective space (phenotypic representation).
|
|
|
|
The template argument Objective\-Vector\-Traits defaults to \doxyref{moeo\-Objective\-Vector\-Traits}{p.}{classmoeoObjectiveVectorTraits}, but it can be replaced at will by any other class that implements the static functions defined therein. Some static funtions to access to the traits characteristics are re-defined in order not to write a lot of typedef's.
|
|
|
|
|
|
|
|
Definition at line 25 of file moeo\-Objective\-Vector.h.
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\index{moeoObjectiveVector@{moeo\-Objective\-Vector}!moeoObjectiveVector@{moeoObjectiveVector}}
|
|
\index{moeoObjectiveVector@{moeoObjectiveVector}!moeoObjectiveVector@{moeo\-Objective\-Vector}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits, class Objective\-Vector\-Type$>$ \bf{moeo\-Objective\-Vector}$<$ Objective\-Vector\-Traits, Objective\-Vector\-Type $>$::\bf{moeo\-Objective\-Vector} (std::vector$<$ \bf{Type} $>$ \& {\em \_\-v})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoObjectiveVector_c504cb6a2086a80aaaf41978032c8ce7}
|
|
|
|
|
|
Ctor from a vector of Type.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-v}]the std::vector $<$ Type $>$ \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 46 of file moeo\-Objective\-Vector.h.
|
|
|
|
\subsection{Member Function Documentation}
|
|
\index{moeoObjectiveVector@{moeo\-Objective\-Vector}!setup@{setup}}
|
|
\index{setup@{setup}!moeoObjectiveVector@{moeo\-Objective\-Vector}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits, class Objective\-Vector\-Type$>$ static void \bf{moeo\-Objective\-Vector}$<$ Objective\-Vector\-Traits, Objective\-Vector\-Type $>$::setup (unsigned int {\em \_\-n\-Objectives}, std::vector$<$ bool $>$ \& {\em \_\-b\-Objectives})\hspace{0.3cm}{\tt [inline, static]}}\label{classmoeoObjectiveVector_0593e2d91be697d9b255513236cb207f}
|
|
|
|
|
|
\doxyref{Parameters} setting (for the objective vector of any solution).
|
|
|
|
\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 55 of file moeo\-Objective\-Vector.h.\index{moeoObjectiveVector@{moeo\-Objective\-Vector}!minimizing@{minimizing}}
|
|
\index{minimizing@{minimizing}!moeoObjectiveVector@{moeo\-Objective\-Vector}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits, class Objective\-Vector\-Type$>$ static bool \bf{moeo\-Objective\-Vector}$<$ Objective\-Vector\-Traits, Objective\-Vector\-Type $>$::minimizing (unsigned int {\em \_\-i})\hspace{0.3cm}{\tt [inline, static]}}\label{classmoeoObjectiveVector_decaf6e3b9a9ac97461d2b271facfc5f}
|
|
|
|
|
|
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 74 of file moeo\-Objective\-Vector.h.\index{moeoObjectiveVector@{moeo\-Objective\-Vector}!maximizing@{maximizing}}
|
|
\index{maximizing@{maximizing}!moeoObjectiveVector@{moeo\-Objective\-Vector}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits, class Objective\-Vector\-Type$>$ static bool \bf{moeo\-Objective\-Vector}$<$ Objective\-Vector\-Traits, Objective\-Vector\-Type $>$::maximizing (unsigned int {\em \_\-i})\hspace{0.3cm}{\tt [inline, static]}}\label{classmoeoObjectiveVector_b62231b0e1c6bb6bab43d6d058871ce3}
|
|
|
|
|
|
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 84 of file moeo\-Objective\-Vector.h.
|
|
|
|
The documentation for this class was generated from the following file:\begin{CompactItemize}
|
|
\item
|
|
moeo\-Objective\-Vector.h\end{CompactItemize}
|