nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

doc update

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@157 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
liefooga 2007-01-15 14:01:11 +00:00
commit b0351ae298
301 changed files with 27492 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

111
trunk/paradiseo-moeo/docs/latex/classmoeoArchive.tex Normal file
View file

@ -0,0 +1,111 @@
\section{moeo\-Archive$<$ EOT $>$ 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$<$ EOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4cm]{classmoeoArchive}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef EOT::Fitness {\bf EOFitness}\label{classmoeoArchive_798bc97d8321b1e2c469e5c341a96dac}
\begin{CompactList}\small\item\em The fitness type of a solution. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
bool {\bf dominates} (const {\bf EOFitness} \&\_\-fit) const
\begin{CompactList}\small\item\em Returns true if the current archive dominates \_\-fit. \item\end{CompactList}\item
bool {\bf contains} (const {\bf EOFitness} \&\_\-fit) const
\begin{CompactList}\small\item\em Returns true if the current archive contains \_\-fit. \item\end{CompactList}\item
void {\bf update} (const EOT \&\_\-eo)
\begin{CompactList}\small\item\em Updates the archive with a given individual \_\-eo. \item\end{CompactList}\item
void {\bf update} (const {\bf eo\-Pop}$<$ EOT $>$ \&\_\-pop)
\begin{CompactList}\small\item\em Updates the archive with a given population \_\-pop. \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class EOT$>$ class moeo\-Archive$<$ EOT $>$}
An archive is a secondary population that stores non-dominated solutions.
Definition at line 21 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 EOT$>$ bool {\bf moeo\-Archive}$<$ EOT $>$::dominates (const {\bf EOFitness} \& {\em \_\-fit}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchive_7786c8bfe67fefa19ac31a4ac700df06}
Returns true if the current archive dominates \_\-fit.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-fit}]the (Pareto) fitness to compare with the current archive \end{description}
\end{Desc}
Definition at line 39 of file moeo\-Archive.h.
Referenced by moeo\-Archive$<$ EOT $>$::update().\index{moeoArchive@{moeo\-Archive}!contains@{contains}}
\index{contains@{contains}!moeoArchive@{moeo\-Archive}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ bool {\bf moeo\-Archive}$<$ EOT $>$::contains (const {\bf EOFitness} \& {\em \_\-fit}) const\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchive_71feaf270daa7185e829caef40bbf956}
Returns true if the current archive contains \_\-fit.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-fit}]the (Pareto) fitness to search within the current archive \end{description}
\end{Desc}
Definition at line 51 of file moeo\-Archive.h.\index{moeoArchive@{moeo\-Archive}!update@{update}}
\index{update@{update}!moeoArchive@{moeo\-Archive}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ void {\bf moeo\-Archive}$<$ EOT $>$::update (const EOT \& {\em \_\-eo})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchive_be9f67bfe41c25537292056d5b30f56a}
Updates the archive with a given individual \_\-eo.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-eo}]the given individual \end{description}
\end{Desc}
Definition at line 63 of file moeo\-Archive.h.
References moeo\-Archive$<$ EOT $>$::dominates().
Referenced by moeo\-Archive$<$ EOT $>$::update().\index{moeoArchive@{moeo\-Archive}!update@{update}}
\index{update@{update}!moeoArchive@{moeo\-Archive}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class EOT$>$ void {\bf moeo\-Archive}$<$ EOT $>$::update (const {\bf eo\-Pop}$<$ EOT $>$ \& {\em \_\-pop})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchive_58e891ab400ba352e8b0a341d0bdc107}
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 98 of file moeo\-Archive.h.
References moeo\-Archive$<$ EOT $>$::update().
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Archive.h\end{CompactItemize}