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

add doc

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@397 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
liefooga 2007-06-26 13:13:33 +00:00
commit b1d6dd41c0
575 changed files with 57465 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

70
branches/paradiseo-moeo-1.0/doc/latex/classmoeoArchiveObjectiveVectorSavingUpdater.tex Normal file
View file

@ -0,0 +1,70 @@
\section{moeo\-Archive\-Objective\-Vector\-Saving\-Updater$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoArchiveObjectiveVectorSavingUpdater}\index{moeoArchiveObjectiveVectorSavingUpdater@{moeoArchiveObjectiveVectorSavingUpdater}}
This class allows to save the objective vectors of the solutions contained in an archive into a file at each generation.
{\tt \#include $<$moeo\-Archive\-Objective\-Vector\-Saving\-Updater.h$>$}
Inheritance diagram for moeo\-Archive\-Objective\-Vector\-Saving\-Updater$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4cm]{classmoeoArchiveObjectiveVectorSavingUpdater}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
\bf{moeo\-Archive\-Objective\-Vector\-Saving\-Updater} (\bf{moeo\-Archive}$<$ MOEOT $>$ \&\_\-arch, const std::string \&\_\-filename, bool \_\-count=false, int \_\-id=-1)
\begin{CompactList}\small\item\em Ctor. \item\end{CompactList}\item
void \bf{operator()} ()\label{classmoeoArchiveObjectiveVectorSavingUpdater_0f6770822c62463ee3b56f7a4c59a850}
\begin{CompactList}\small\item\em Saves the fitness of the archive's members into the file. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
\bf{moeo\-Archive}$<$ MOEOT $>$ \& \bf{arch}\label{classmoeoArchiveObjectiveVectorSavingUpdater_b252eed0ea4f837efefdcdd81d5c42a6}
\begin{CompactList}\small\item\em local archive \item\end{CompactList}\item
std::string \bf{filename}\label{classmoeoArchiveObjectiveVectorSavingUpdater_7571569a5fb6df07f5d4e72310ec4d4d}
\begin{CompactList}\small\item\em target filename \item\end{CompactList}\item
bool \bf{count}\label{classmoeoArchiveObjectiveVectorSavingUpdater_6eb54eb29152e2d357b1b975ce33c062}
\begin{CompactList}\small\item\em this variable is set to true if a new file have to be created each time () is called and to false if the file only HAVE to be updated \item\end{CompactList}\item
unsigned int \bf{counter}\label{classmoeoArchiveObjectiveVectorSavingUpdater_5ea4722f75597976cf6a21a7fba3ddbc}
\begin{CompactList}\small\item\em counter \item\end{CompactList}\item
int \bf{id}\label{classmoeoArchiveObjectiveVectorSavingUpdater_cd6940347cf39a47085c4d0a7c558355}
\begin{CompactList}\small\item\em own ID \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Archive\-Objective\-Vector\-Saving\-Updater$<$ MOEOT $>$}
This class allows to save the objective vectors of the solutions contained in an archive into a file at each generation.
Definition at line 28 of file moeo\-Archive\-Objective\-Vector\-Saving\-Updater.h.
\subsection{Constructor \& Destructor Documentation}
\index{moeoArchiveObjectiveVectorSavingUpdater@{moeo\-Archive\-Objective\-Vector\-Saving\-Updater}!moeoArchiveObjectiveVectorSavingUpdater@{moeoArchiveObjectiveVectorSavingUpdater}}
\index{moeoArchiveObjectiveVectorSavingUpdater@{moeoArchiveObjectiveVectorSavingUpdater}!moeoArchiveObjectiveVectorSavingUpdater@{moeo\-Archive\-Objective\-Vector\-Saving\-Updater}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ \bf{moeo\-Archive\-Objective\-Vector\-Saving\-Updater}$<$ MOEOT $>$::\bf{moeo\-Archive\-Objective\-Vector\-Saving\-Updater} (\bf{moeo\-Archive}$<$ MOEOT $>$ \& {\em \_\-arch}, const std::string \& {\em \_\-filename}, bool {\em \_\-count} = {\tt false}, int {\em \_\-id} = {\tt -1})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoArchiveObjectiveVectorSavingUpdater_d9f70d24605ccd1e89c8b4ea4c96c333}
Ctor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-arch}]local archive \item[{\em \_\-filename}]target filename \item[{\em \_\-count}]put this variable to true if you want a new file to be created each time () is called and to false if you only want the file to be updated \item[{\em \_\-id}]own ID \end{description}
\end{Desc}
Definition at line 39 of file moeo\-Archive\-Objective\-Vector\-Saving\-Updater.h.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Archive\-Objective\-Vector\-Saving\-Updater.h\end{CompactItemize}