f58813fd6e
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@558 331e1502-861f-0410-8da2-ba01fb791d7f
170 lines
8.2 KiB
TeX
170 lines
8.2 KiB
TeX
\section{moeo\-Archive$<$ MOEOT $>$ Class Template Reference}
|
|
\label{classmoeoArchive}\index{moeoArchive@{moeoArchive}}
|
|
An archive is a secondary population that stores non-dominated solutions.
|
|
|
|
|
|
{\tt \#include $<$moeo\-Archive.h$>$}
|
|
|
|
Inheritance diagram for moeo\-Archive$<$ MOEOT $>$::\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=4cm]{classmoeoArchive}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Public Types}
|
|
\begin{CompactItemize}
|
|
\item
|
|
typedef MOEOT::Objective\-Vector \bf{Objective\-Vector}\label{classmoeoArchive_655f6879b14d7b4e65ea03724e5ee601}
|
|
|
|
\begin{CompactList}\small\item\em The type of an objective vector for a solution. \item\end{CompactList}\end{CompactItemize}
|
|
\subsection*{Public Member Functions}
|
|
\begin{CompactItemize}
|
|
\item
|
|
\bf{moeo\-Archive} ()
|
|
\begin{CompactList}\small\item\em Default ctor. \item\end{CompactList}\item
|
|
\bf{moeo\-Archive} (\bf{moeo\-Objective\-Vector\-Comparator}$<$ \bf{Objective\-Vector} $>$ \&\_\-comparator)
|
|
\begin{CompactList}\small\item\em Ctor. \item\end{CompactList}\item
|
|
bool \bf{dominates} (const \bf{Objective\-Vector} \&\_\-objective\-Vector) const
|
|
\begin{CompactList}\small\item\em Returns true if the current archive dominates \_\-objective\-Vector according to the \doxyref{moeo\-Objective\-Vector\-Comparator}{p.}{classmoeoObjectiveVectorComparator} given in the constructor. \item\end{CompactList}\item
|
|
bool \bf{contains} (const \bf{Objective\-Vector} \&\_\-objective\-Vector) const
|
|
\begin{CompactList}\small\item\em Returns true if the current archive already contains a solution with the same objective values than \_\-objective\-Vector. \item\end{CompactList}\item
|
|
void \bf{update} (const MOEOT \&\_\-moeo)
|
|
\begin{CompactList}\small\item\em Updates the archive with a given individual \_\-moeo. \item\end{CompactList}\item
|
|
void \bf{update} (const \bf{eo\-Pop}$<$ MOEOT $>$ \&\_\-pop)
|
|
\begin{CompactList}\small\item\em Updates the archive with a given population \_\-pop. \item\end{CompactList}\item
|
|
bool \bf{equals} (const \bf{moeo\-Archive}$<$ MOEOT $>$ \&\_\-arch)
|
|
\begin{CompactList}\small\item\em Returns true if the current archive contains the same objective vectors than the given archive \_\-arch. \item\end{CompactList}\end{CompactItemize}
|
|
\subsection*{Private Attributes}
|
|
\begin{CompactItemize}
|
|
\item
|
|
\bf{moeo\-Objective\-Vector\-Comparator}$<$ \bf{Objective\-Vector} $>$ \& \bf{comparator}\label{classmoeoArchive_59d96d161a53b3ee50df8ca5ad0d0642}
|
|
|
|
\begin{CompactList}\small\item\em The \doxyref{moeo\-Objective\-Vector\-Comparator}{p.}{classmoeoObjectiveVectorComparator} used to compare solutions. \item\end{CompactList}\item
|
|
\bf{moeo\-Pareto\-Objective\-Vector\-Comparator}$<$ \bf{Objective\-Vector} $>$ \bf{pareto\-Comparator}\label{classmoeoArchive_eefd5b82b1d7f7d60c72683da9cd8682}
|
|
|
|
\begin{CompactList}\small\item\em A \doxyref{moeo\-Objective\-Vector\-Comparator}{p.}{classmoeoObjectiveVectorComparator} based on Pareto dominance (used as default). \item\end{CompactList}\end{CompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Archive$<$ MOEOT $>$}
|
|
|
|
An archive is a secondary population that stores non-dominated solutions.
|
|
|
|
|
|
|
|
Definition at line 24 of file moeo\-Archive.h.
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\index{moeoArchive@{moeo\-Archive}!moeoArchive@{moeoArchive}}
|
|
\index{moeoArchive@{moeoArchive}!moeoArchive@{moeo\-Archive}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ \bf{moeo\-Archive}$<$ MOEOT $>$::\bf{moeo\-Archive} ()\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchive_a593ca2122484d255b5aa5a0463bd913}
|
|
|
|
|
|
Default ctor.
|
|
|
|
The \doxyref{moeo\-Objective\-Vector\-Comparator}{p.}{classmoeoObjectiveVectorComparator} used to compare solutions is based on Pareto dominance
|
|
|
|
Definition at line 44 of file moeo\-Archive.h.\index{moeoArchive@{moeo\-Archive}!moeoArchive@{moeoArchive}}
|
|
\index{moeoArchive@{moeoArchive}!moeoArchive@{moeo\-Archive}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ \bf{moeo\-Archive}$<$ MOEOT $>$::\bf{moeo\-Archive} (\bf{moeo\-Objective\-Vector\-Comparator}$<$ \bf{Objective\-Vector} $>$ \& {\em \_\-comparator})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchive_75e5fee339ca463405434f6f48497de0}
|
|
|
|
|
|
Ctor.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-comparator}]the \doxyref{moeo\-Objective\-Vector\-Comparator}{p.}{classmoeoObjectiveVectorComparator} used to compare solutions \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 52 of file moeo\-Archive.h.
|
|
|
|
\subsection{Member Function Documentation}
|
|
\index{moeoArchive@{moeo\-Archive}!dominates@{dominates}}
|
|
\index{dominates@{dominates}!moeoArchive@{moeo\-Archive}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ bool \bf{moeo\-Archive}$<$ MOEOT $>$::dominates (const \bf{Objective\-Vector} \& {\em \_\-objective\-Vector}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchive_67f667e822e0485c6976c6ee0d18f70a}
|
|
|
|
|
|
Returns true if the current archive dominates \_\-objective\-Vector according to the \doxyref{moeo\-Objective\-Vector\-Comparator}{p.}{classmoeoObjectiveVectorComparator} given in the constructor.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-objective\-Vector}]the objective vector to compare with the current archive \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 60 of file moeo\-Archive.h.
|
|
|
|
References moeo\-Archive$<$ MOEOT $>$::comparator.\index{moeoArchive@{moeo\-Archive}!contains@{contains}}
|
|
\index{contains@{contains}!moeoArchive@{moeo\-Archive}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ bool \bf{moeo\-Archive}$<$ MOEOT $>$::contains (const \bf{Objective\-Vector} \& {\em \_\-objective\-Vector}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchive_748d5c75d713075288257192be1986a9}
|
|
|
|
|
|
Returns true if the current archive already contains a solution with the same objective values than \_\-objective\-Vector.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-objective\-Vector}]the objective vector to compare with the current archive \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 78 of file moeo\-Archive.h.
|
|
|
|
Referenced by moeo\-Archive$<$ MOEOT $>$::equals().\index{moeoArchive@{moeo\-Archive}!update@{update}}
|
|
\index{update@{update}!moeoArchive@{moeo\-Archive}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-Archive}$<$ MOEOT $>$::update (const MOEOT \& {\em \_\-moeo})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchive_6df0acd84cab4cb53682f2e6ca850e9a}
|
|
|
|
|
|
Updates the archive with a given individual \_\-moeo.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-moeo}]the given individual \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 95 of file moeo\-Archive.h.
|
|
|
|
References moeo\-Archive$<$ MOEOT $>$::comparator.
|
|
|
|
Referenced by moeo\-Archive$<$ MOEOT $>$::update().\index{moeoArchive@{moeo\-Archive}!update@{update}}
|
|
\index{update@{update}!moeoArchive@{moeo\-Archive}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ void \bf{moeo\-Archive}$<$ MOEOT $>$::update (const \bf{eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchive_877bf4f0937f6be263e2686df4e77cf3}
|
|
|
|
|
|
Updates the archive with a given population \_\-pop.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-pop}]the given population \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 138 of file moeo\-Archive.h.
|
|
|
|
References moeo\-Archive$<$ MOEOT $>$::update().\index{moeoArchive@{moeo\-Archive}!equals@{equals}}
|
|
\index{equals@{equals}!moeoArchive@{moeo\-Archive}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ bool \bf{moeo\-Archive}$<$ MOEOT $>$::equals (const \bf{moeo\-Archive}$<$ MOEOT $>$ \& {\em \_\-arch})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchive_937088a6054ba1b50db651f50dda3a72}
|
|
|
|
|
|
Returns true if the current archive contains the same objective vectors than the given archive \_\-arch.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em \_\-arch}]the given archive \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 151 of file moeo\-Archive.h.
|
|
|
|
References moeo\-Archive$<$ MOEOT $>$::contains().
|
|
|
|
The documentation for this class was generated from the following file:\begin{CompactItemize}
|
|
\item
|
|
moeo\-Archive.h\end{CompactItemize}
|