2e7e817428
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@263 331e1502-861f-0410-8da2-ba01fb791d7f
135 lines
7.3 KiB
TeX
135 lines
7.3 KiB
TeX
\section{moeo\-Vector$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity, Gene\-Type $>$ Class Template Reference}
|
|
\label{classmoeoVector}\index{moeoVector@{moeoVector}}
|
|
Base class for fixed length chromosomes, just derives from \doxyref{MOEO}{p.}{classMOEO} and std::vector and redirects the smaller than operator to MOEO (objective vector based comparison).
|
|
|
|
|
|
{\tt \#include $<$moeo\-Vector.h$>$}
|
|
|
|
Inheritance diagram for moeo\-Vector$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity, Gene\-Type $>$::\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=2.82258cm]{classmoeoVector}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Public Types}
|
|
\begin{CompactItemize}
|
|
\item
|
|
typedef Gene\-Type {\bf Atom\-Type}\label{classmoeoVector_9d4400084dec28c37e392bb8b0a0b452}
|
|
|
|
\begin{CompactList}\small\item\em the atomic type \item\end{CompactList}\item
|
|
typedef std::vector$<$ Gene\-Type $>$ {\bf Container\-Type}\label{classmoeoVector_b0fb83132e1f2c8b8258013a01aeb364}
|
|
|
|
\begin{CompactList}\small\item\em the container type \item\end{CompactList}\end{CompactItemize}
|
|
\subsection*{Public Member Functions}
|
|
\begin{CompactItemize}
|
|
\item
|
|
{\bf moeo\-Vector} (unsigned \_\-size=0, Gene\-Type \_\-value=Gene\-Type())
|
|
\begin{CompactList}\small\item\em Default ctor. \item\end{CompactList}\item
|
|
void {\bf value} (const std::vector$<$ Gene\-Type $>$ \&\_\-v)
|
|
\begin{CompactList}\small\item\em We can't have a Ctor from a std::vector as it would create ambiguity with the copy Ctor. \item\end{CompactList}\item
|
|
bool {\bf operator$<$} (const {\bf moeo\-Vector}$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity, Gene\-Type $>$ \&\_\-moeo) const
|
|
\begin{CompactList}\small\item\em To avoid conflicts between \doxyref{MOEO::operator$<$}{p.}{classMOEO_d38eef435511ba3a5a310712a608f4ab} and std::vector$<$Gene\-Type$>$::operator$<$. \item\end{CompactList}\item
|
|
virtual void {\bf print\-On} (std::ostream \&\_\-os) const
|
|
\begin{CompactList}\small\item\em Writing object. \item\end{CompactList}\item
|
|
virtual void {\bf read\-From} (std::istream \&\_\-is)
|
|
\begin{CompactList}\small\item\em Reading object. \item\end{CompactList}\end{CompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
\subsubsection*{template$<$class MOEOObjective\-Vector, class MOEOFitness, class MOEODiversity, class Gene\-Type$>$ class moeo\-Vector$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity, Gene\-Type $>$}
|
|
|
|
Base class for fixed length chromosomes, just derives from \doxyref{MOEO}{p.}{classMOEO} and std::vector and redirects the smaller than operator to MOEO (objective vector based comparison).
|
|
|
|
Gene\-Type must have the following methods: void ctor (needed for the std::vector$<$$>$), copy ctor.
|
|
|
|
|
|
|
|
Definition at line 25 of file moeo\-Vector.h.
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\index{moeoVector@{moeo\-Vector}!moeoVector@{moeoVector}}
|
|
\index{moeoVector@{moeoVector}!moeoVector@{moeo\-Vector}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOObjective\-Vector, class MOEOFitness, class MOEODiversity, class Gene\-Type$>$ {\bf moeo\-Vector}$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity, Gene\-Type $>$::{\bf moeo\-Vector} (unsigned {\em \_\-size} = {\tt 0}, Gene\-Type {\em \_\-value} = {\tt GeneType()})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoVector_69ea6b5008e6103bf0ae5089302c3b96}
|
|
|
|
|
|
Default ctor.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-size}]Length of vector (default is 0) \item[{\em \_\-value}]Initial value of all elements (default is default value of type Gene\-Type) \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 47 of file moeo\-Vector.h.
|
|
|
|
\subsection{Member Function Documentation}
|
|
\index{moeoVector@{moeo\-Vector}!value@{value}}
|
|
\index{value@{value}!moeoVector@{moeo\-Vector}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOObjective\-Vector, class MOEOFitness, class MOEODiversity, class Gene\-Type$>$ void {\bf moeo\-Vector}$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity, Gene\-Type $>$::value (const std::vector$<$ Gene\-Type $>$ \& {\em \_\-v})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoVector_a7fadd876fe492717815510f68a921c5}
|
|
|
|
|
|
We can't have a Ctor from a std::vector as it would create ambiguity with the copy Ctor.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-v}]a vector of Gene\-Type \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 56 of file moeo\-Vector.h.\index{moeoVector@{moeo\-Vector}!operator<@{operator$<$}}
|
|
\index{operator<@{operator$<$}!moeoVector@{moeo\-Vector}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOObjective\-Vector, class MOEOFitness, class MOEODiversity, class Gene\-Type$>$ bool {\bf moeo\-Vector}$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity, Gene\-Type $>$::operator$<$ (const {\bf moeo\-Vector}$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity, Gene\-Type $>$ \& {\em \_\-moeo}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoVector_d7a5feff640f00e5d6a29c3ebd11e90b}
|
|
|
|
|
|
To avoid conflicts between \doxyref{MOEO::operator$<$}{p.}{classMOEO_d38eef435511ba3a5a310712a608f4ab} and std::vector$<$Gene\-Type$>$::operator$<$.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-moeo}]the object to compare with \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 75 of file moeo\-Vector.h.\index{moeoVector@{moeo\-Vector}!printOn@{printOn}}
|
|
\index{printOn@{printOn}!moeoVector@{moeo\-Vector}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOObjective\-Vector, class MOEOFitness, class MOEODiversity, class Gene\-Type$>$ virtual void {\bf moeo\-Vector}$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity, Gene\-Type $>$::print\-On (std::ostream \& {\em \_\-os}) const\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmoeoVector_c327325a47954f69df985da96d2c171a}
|
|
|
|
|
|
Writing object.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-os}]output stream \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Reimplemented from {\bf MOEO$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity $>$} \doxyref{}{p.}{classMOEO_99e3dbc645fd2c23a82e9303683a05c5}.
|
|
|
|
Reimplemented in {\bf moeo\-Bit\-Vector$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity $>$} \doxyref{}{p.}{classmoeoBitVector_e54c36ce64b849a6846953a25247a861}.
|
|
|
|
Definition at line 85 of file moeo\-Vector.h.\index{moeoVector@{moeo\-Vector}!readFrom@{readFrom}}
|
|
\index{readFrom@{readFrom}!moeoVector@{moeo\-Vector}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOObjective\-Vector, class MOEOFitness, class MOEODiversity, class Gene\-Type$>$ virtual void {\bf moeo\-Vector}$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity, Gene\-Type $>$::read\-From (std::istream \& {\em \_\-is})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classmoeoVector_cd8ee0fe79bb9515b29e2a4d3fee5ab9}
|
|
|
|
|
|
Reading object.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-is}]input stream \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Reimplemented from {\bf MOEO$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity $>$} \doxyref{}{p.}{classMOEO_1bbd9cb1a7709592bf4bc29dff8c5273}.
|
|
|
|
Reimplemented in {\bf moeo\-Bit\-Vector$<$ MOEOObjective\-Vector, MOEOFitness, MOEODiversity $>$} \doxyref{}{p.}{classmoeoBitVector_31cd3f894615d0a27dd116a5c8082521}.
|
|
|
|
Definition at line 98 of file moeo\-Vector.h.
|
|
|
|
The documentation for this class was generated from the following file:\begin{CompactItemize}
|
|
\item
|
|
moeo\-Vector.h\end{CompactItemize}
|