paradiseo/trunk/paradiseo-moeo/docs/latex/classmoeoBinaryMetricSavingUpdater.tex
liefooga 2e7e817428 update docs
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@263 331e1502-861f-0410-8da2-ba01fb791d7f
2007-04-17 15:45:01 +00:00

79 lines
4.5 KiB
TeX

\section{moeo\-Binary\-Metric\-Saving\-Updater$<$ MOEOT $>$ Class Template Reference}
\label{classmoeoBinaryMetricSavingUpdater}\index{moeoBinaryMetricSavingUpdater@{moeoBinaryMetricSavingUpdater}}
This class allows to save the progression of a binary metric comparing the objective vectors of the current population (or archive) with the objective vectors of the population (or archive) of the generation (n-1) into a file.
{\tt \#include $<$moeo\-Binary\-Metric\-Saving\-Updater.h$>$}
Inheritance diagram for moeo\-Binary\-Metric\-Saving\-Updater$<$ MOEOT $>$::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4cm]{classmoeoBinaryMetricSavingUpdater}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item
typedef MOEOT::Objective\-Vector {\bf Objective\-Vector}\label{classmoeoBinaryMetricSavingUpdater_21c2b12ee8600d8550eff42bcba87fd2}
\begin{CompactList}\small\item\em The objective vector type of a solution. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf moeo\-Binary\-Metric\-Saving\-Updater} ({\bf moeo\-Vector\-Vs\-Vector\-Binary\-Metric}$<$ {\bf Objective\-Vector}, double $>$ \&\_\-metric, const {\bf eo\-Pop}$<$ MOEOT $>$ \&\_\-pop, std::string \_\-filename)
\begin{CompactList}\small\item\em Ctor. \item\end{CompactList}\item
void {\bf operator()} ()\label{classmoeoBinaryMetricSavingUpdater_a4f0a9e86b4a39ef88e7f8e1c1d6d229}
\begin{CompactList}\small\item\em Saves the metric's value for the current generation. \item\end{CompactList}\end{CompactItemize}
\subsection*{Private Attributes}
\begin{CompactItemize}
\item
{\bf moeo\-Vector\-Vs\-Vector\-Binary\-Metric}$<$ {\bf Objective\-Vector}, double $>$ \& {\bf metric}\label{classmoeoBinaryMetricSavingUpdater_d1c66d6d179aff03d6949f4f76d3237c}
\begin{CompactList}\small\item\em binary metric comparing two Pareto sets \item\end{CompactList}\item
const {\bf eo\-Pop}$<$ MOEOT $>$ \& {\bf pop}\label{classmoeoBinaryMetricSavingUpdater_79eea0916733568929ea9c0758ffe8fa}
\begin{CompactList}\small\item\em main population \item\end{CompactList}\item
{\bf eo\-Pop}$<$ MOEOT $>$ {\bf old\-Pop}\label{classmoeoBinaryMetricSavingUpdater_0461af7e569921fec49538ff8fa998d4}
\begin{CompactList}\small\item\em (n-1) population \item\end{CompactList}\item
std::string {\bf filename}\label{classmoeoBinaryMetricSavingUpdater_6d280c180de7bab1e18ab2bb39a0e184}
\begin{CompactList}\small\item\em target filename \item\end{CompactList}\item
bool {\bf first\-Gen}\label{classmoeoBinaryMetricSavingUpdater_9bfa927499265f53f2b25afd2cd3c94f}
\begin{CompactList}\small\item\em is it the first generation ? \item\end{CompactList}\item
unsigned {\bf counter}\label{classmoeoBinaryMetricSavingUpdater_02339c6081864e43667860445d96a909}
\begin{CompactList}\small\item\em counter \item\end{CompactList}\end{CompactItemize}
\subsection{Detailed Description}
\subsubsection*{template$<$class MOEOT$>$ class moeo\-Binary\-Metric\-Saving\-Updater$<$ MOEOT $>$}
This class allows to save the progression of a binary metric comparing the objective vectors of the current population (or archive) with the objective vectors of the population (or archive) of the generation (n-1) into a file.
Definition at line 27 of file moeo\-Binary\-Metric\-Saving\-Updater.h.
\subsection{Constructor \& Destructor Documentation}
\index{moeoBinaryMetricSavingUpdater@{moeo\-Binary\-Metric\-Saving\-Updater}!moeoBinaryMetricSavingUpdater@{moeoBinaryMetricSavingUpdater}}
\index{moeoBinaryMetricSavingUpdater@{moeoBinaryMetricSavingUpdater}!moeoBinaryMetricSavingUpdater@{moeo\-Binary\-Metric\-Saving\-Updater}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class MOEOT$>$ {\bf moeo\-Binary\-Metric\-Saving\-Updater}$<$ MOEOT $>$::{\bf moeo\-Binary\-Metric\-Saving\-Updater} ({\bf moeo\-Vector\-Vs\-Vector\-Binary\-Metric}$<$ {\bf Objective\-Vector}, double $>$ \& {\em \_\-metric}, const {\bf eo\-Pop}$<$ MOEOT $>$ \& {\em \_\-pop}, std::string {\em \_\-filename})\hspace{0.3cm}{\tt [inline]}}\label{classmoeoBinaryMetricSavingUpdater_b7c3fb73caf759450367c76d4716bb62}
Ctor.
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em \_\-metric}]the binary metric comparing two Pareto sets \item[{\em \_\-pop}]the main population \item[{\em \_\-filename}]the target filename \end{description}
\end{Desc}
Definition at line 42 of file moeo\-Binary\-Metric\-Saving\-Updater.h.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
moeo\-Binary\-Metric\-Saving\-Updater.h\end{CompactItemize}