2e7e817428
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@263 331e1502-861f-0410-8da2-ba01fb791d7f
92 lines
4.7 KiB
TeX
92 lines
4.7 KiB
TeX
\section{moeo\-Objective\-Vector$<$ Objective\-Vector\-Traits $>$ 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$>$}
|
|
|
|
Inheritance diagram for moeo\-Objective\-Vector$<$ Objective\-Vector\-Traits $>$::\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=2cm]{classmoeoObjectiveVector}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Public Types}
|
|
\begin{CompactItemize}
|
|
\item
|
|
typedef Objective\-Vector\-Traits {\bf Traits}\label{classmoeoObjectiveVector_f7085174831edefb79ef5365aee86f87}
|
|
|
|
\begin{CompactList}\small\item\em The traits of objective vectors. \item\end{CompactList}\end{CompactItemize}
|
|
\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 (for the objective vector of any solution). \item\end{CompactList}\item
|
|
static unsigned {\bf n\-Objectives} ()\label{classmoeoObjectiveVector_b5b74b561422cd7cd56924a8f974eee3}
|
|
|
|
\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}\end{CompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
\subsubsection*{template$<$class Objective\-Vector\-Traits$>$ class moeo\-Objective\-Vector$<$ Objective\-Vector\-Traits $>$}
|
|
|
|
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 28 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$>$ static void {\bf moeo\-Objective\-Vector}$<$ Objective\-Vector\-Traits $>$::setup (unsigned {\em \_\-n\-Objectives}, std::vector$<$ bool $>$ \& {\em \_\-b\-Objectives})\hspace{0.3cm}{\tt [inline, static]}}\label{classmoeoObjectiveVector_126770eefd109a84c010f5cbc46e2be3}
|
|
|
|
|
|
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 41 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$>$ static bool {\bf moeo\-Objective\-Vector}$<$ Objective\-Vector\-Traits $>$::minimizing (unsigned {\em \_\-i})\hspace{0.3cm}{\tt [inline, static]}}\label{classmoeoObjectiveVector_6b5cb023de954c9a58f56f45e3ad8e5c}
|
|
|
|
|
|
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 60 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$>$ static bool {\bf moeo\-Objective\-Vector}$<$ Objective\-Vector\-Traits $>$::maximizing (unsigned {\em \_\-i})\hspace{0.3cm}{\tt [inline, static]}}\label{classmoeoObjectiveVector_83e65052452ce9036d49f0868ddd7326}
|
|
|
|
|
|
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 69 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}
|