b1d6dd41c0
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@397 331e1502-861f-0410-8da2-ba01fb791d7f
181 lines
13 KiB
TeX
181 lines
13 KiB
TeX
\section{moeo\-Objective\-Vector\-Double$<$ Objective\-Vector\-Traits $>$ Class Template Reference}
|
|
\label{classmoeoObjectiveVectorDouble}\index{moeoObjectiveVectorDouble@{moeoObjectiveVectorDouble}}
|
|
This class allows to represent a solution in the objective space (phenotypic representation) by a std::vector of doubles, i.e.
|
|
|
|
|
|
{\tt \#include $<$moeo\-Objective\-Vector\-Double.h$>$}
|
|
|
|
Inheritance diagram for moeo\-Objective\-Vector\-Double$<$ Objective\-Vector\-Traits $>$::\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=2cm]{classmoeoObjectiveVectorDouble}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Public Member Functions}
|
|
\begin{CompactItemize}
|
|
\item
|
|
\bf{moeo\-Objective\-Vector\-Double} (double \_\-value=0.0)\label{classmoeoObjectiveVectorDouble_9d4c470ac87733521084175552874837}
|
|
|
|
\begin{CompactList}\small\item\em Ctor. \item\end{CompactList}\item
|
|
\bf{moeo\-Objective\-Vector\-Double} (std::vector$<$ double $>$ \&\_\-v)
|
|
\begin{CompactList}\small\item\em Ctor from a vector of doubles. \item\end{CompactList}\item
|
|
bool \bf{dominates} (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \&\_\-other) const
|
|
\begin{CompactList}\small\item\em Returns true if the current objective vector dominates \_\-other according to the Pareto dominance relation (but it's better to use a \doxyref{moeo\-Objective\-Vector\-Comparator}{p.}{classmoeoObjectiveVectorComparator} object to compare solutions). \item\end{CompactList}\item
|
|
bool \bf{operator==} (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \&\_\-other) const
|
|
\begin{CompactList}\small\item\em Returns true if the current objective vector is equal to \_\-other (according to a tolerance value). \item\end{CompactList}\item
|
|
bool \bf{operator!=} (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \&\_\-other) const
|
|
\begin{CompactList}\small\item\em Returns true if the current objective vector is different than \_\-other (according to a tolerance value). \item\end{CompactList}\item
|
|
bool \bf{operator$<$} (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \&\_\-other) const
|
|
\begin{CompactList}\small\item\em Returns true if the current objective vector is smaller than \_\-other on the first objective, then on the second, and so on (can be usefull for sorting/printing). \item\end{CompactList}\item
|
|
bool \bf{operator$>$} (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \&\_\-other) const
|
|
\begin{CompactList}\small\item\em Returns true if the current objective vector is greater than \_\-other on the first objective, then on the second, and so on (can be usefull for sorting/printing). \item\end{CompactList}\item
|
|
bool \bf{operator$<$=} (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \&\_\-other) const
|
|
\begin{CompactList}\small\item\em Returns true if the current objective vector is smaller than or equal to \_\-other on the first objective, then on the second, and so on (can be usefull for sorting/printing). \item\end{CompactList}\item
|
|
bool \bf{operator$>$=} (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \&\_\-other) const
|
|
\begin{CompactList}\small\item\em Returns true if the current objective vector is greater than or equal to \_\-other on the first objective, then on the second, and so on (can be usefull for sorting/printing). \item\end{CompactList}\end{CompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
\subsubsection*{template$<$class Objective\-Vector\-Traits$>$ class moeo\-Objective\-Vector\-Double$<$ Objective\-Vector\-Traits $>$}
|
|
|
|
This class allows to represent a solution in the objective space (phenotypic representation) by a std::vector of doubles, i.e.
|
|
|
|
that an objective value is represented using a double, and this for any objective.
|
|
|
|
|
|
|
|
Definition at line 27 of file moeo\-Objective\-Vector\-Double.h.
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\index{moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}!moeoObjectiveVectorDouble@{moeoObjectiveVectorDouble}}
|
|
\index{moeoObjectiveVectorDouble@{moeoObjectiveVectorDouble}!moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits$>$ \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$::\bf{moeo\-Objective\-Vector\-Double} (std::vector$<$ double $>$ \& {\em \_\-v})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoObjectiveVectorDouble_99f4a743424ed8384ad97fd36e3123d9}
|
|
|
|
|
|
Ctor from a vector of doubles.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-v}]the std::vector $<$ double $>$ \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 45 of file moeo\-Objective\-Vector\-Double.h.
|
|
|
|
\subsection{Member Function Documentation}
|
|
\index{moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}!dominates@{dominates}}
|
|
\index{dominates@{dominates}!moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits$>$ bool \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$::dominates (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \& {\em \_\-other}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoObjectiveVectorDouble_f4aa764abee12a28ae30ae6bb23083f4}
|
|
|
|
|
|
Returns true if the current objective vector dominates \_\-other according to the Pareto dominance relation (but it's better to use a \doxyref{moeo\-Objective\-Vector\-Comparator}{p.}{classmoeoObjectiveVectorComparator} object to compare solutions).
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-other}]the other \doxyref{moeo\-Objective\-Vector\-Double}{p.}{classmoeoObjectiveVectorDouble} object to compare with \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 54 of file moeo\-Objective\-Vector\-Double.h.\index{moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}!operator==@{operator==}}
|
|
\index{operator==@{operator==}!moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits$>$ bool \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$::operator== (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \& {\em \_\-other}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoObjectiveVectorDouble_cf09615e1a38924ee4fb6250047f9d77}
|
|
|
|
|
|
Returns true if the current objective vector is equal to \_\-other (according to a tolerance value).
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-other}]the other \doxyref{moeo\-Objective\-Vector\-Double}{p.}{classmoeoObjectiveVectorDouble} object to compare with \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 65 of file moeo\-Objective\-Vector\-Double.h.
|
|
|
|
Referenced by moeo\-Objective\-Vector\-Double$<$ Objective\-Vector\-Traits $>$::operator!=(), and moeo\-Objective\-Vector\-Double$<$ Objective\-Vector\-Traits $>$::operator$>$=().\index{moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}!operator"!=@{operator"!=}}
|
|
\index{operator"!=@{operator"!=}!moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits$>$ bool \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$::operator!= (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \& {\em \_\-other}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoObjectiveVectorDouble_367e69818ebe05a932510e6516c54fdb}
|
|
|
|
|
|
Returns true if the current objective vector is different than \_\-other (according to a tolerance value).
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-other}]the other \doxyref{moeo\-Objective\-Vector\-Double}{p.}{classmoeoObjectiveVectorDouble} object to compare with \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 82 of file moeo\-Objective\-Vector\-Double.h.
|
|
|
|
References moeo\-Objective\-Vector\-Double$<$ Objective\-Vector\-Traits $>$::operator==().\index{moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}!operator<@{operator$<$}}
|
|
\index{operator<@{operator$<$}!moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits$>$ bool \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$::operator$<$ (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \& {\em \_\-other}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoObjectiveVectorDouble_5616d7504e6b29848ca38b52e9eb44e0}
|
|
|
|
|
|
Returns true if the current objective vector is smaller than \_\-other on the first objective, then on the second, and so on (can be usefull for sorting/printing).
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-other}]the other \doxyref{moeo\-Objective\-Vector\-Double}{p.}{classmoeoObjectiveVectorDouble} object to compare with \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 93 of file moeo\-Objective\-Vector\-Double.h.
|
|
|
|
Referenced by moeo\-Objective\-Vector\-Double$<$ Objective\-Vector\-Traits $>$::operator$<$=().\index{moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}!operator>@{operator$>$}}
|
|
\index{operator>@{operator$>$}!moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits$>$ bool \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$::operator$>$ (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \& {\em \_\-other}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoObjectiveVectorDouble_50de392d10bd90ad125f26efb8ea5f3d}
|
|
|
|
|
|
Returns true if the current objective vector is greater than \_\-other on the first objective, then on the second, and so on (can be usefull for sorting/printing).
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-other}]the other \doxyref{moeo\-Objective\-Vector\-Double}{p.}{classmoeoObjectiveVectorDouble} object to compare with \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 105 of file moeo\-Objective\-Vector\-Double.h.
|
|
|
|
Referenced by moeo\-Objective\-Vector\-Double$<$ Objective\-Vector\-Traits $>$::operator$>$=().\index{moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}!operator<=@{operator$<$=}}
|
|
\index{operator<=@{operator$<$=}!moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits$>$ bool \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$::operator$<$= (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \& {\em \_\-other}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoObjectiveVectorDouble_11728f07ebd7d72fe331679913888d3f}
|
|
|
|
|
|
Returns true if the current objective vector is smaller than or equal to \_\-other on the first objective, then on the second, and so on (can be usefull for sorting/printing).
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-other}]the other \doxyref{moeo\-Objective\-Vector\-Double}{p.}{classmoeoObjectiveVectorDouble} object to compare with \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 116 of file moeo\-Objective\-Vector\-Double.h.
|
|
|
|
References moeo\-Objective\-Vector\-Double$<$ Objective\-Vector\-Traits $>$::operator$<$().\index{moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}!operator>=@{operator$>$=}}
|
|
\index{operator>=@{operator$>$=}!moeoObjectiveVectorDouble@{moeo\-Objective\-Vector\-Double}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class Objective\-Vector\-Traits$>$ bool \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$::operator$>$= (const \bf{moeo\-Objective\-Vector\-Double}$<$ Objective\-Vector\-Traits $>$ \& {\em \_\-other}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoObjectiveVectorDouble_74057cd0d8325513d186aea6034d7901}
|
|
|
|
|
|
Returns true if the current objective vector is greater than or equal to \_\-other on the first objective, then on the second, and so on (can be usefull for sorting/printing).
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-other}]the other \doxyref{moeo\-Objective\-Vector\-Double}{p.}{classmoeoObjectiveVectorDouble} object to compare with \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 127 of file moeo\-Objective\-Vector\-Double.h.
|
|
|
|
References moeo\-Objective\-Vector\-Double$<$ Objective\-Vector\-Traits $>$::operator==(), and moeo\-Objective\-Vector\-Double$<$ Objective\-Vector\-Traits $>$::operator$>$().
|
|
|
|
The documentation for this class was generated from the following file:\begin{CompactItemize}
|
|
\item
|
|
moeo\-Objective\-Vector\-Double.h\end{CompactItemize}
|