[99] | 1 | \section{logger Class Reference} |
---|
| 2 | \label{classlogger}\index{logger@{logger}} |
---|
| 3 | Class for storing results (and semi-results) of an experiment. |
---|
| 4 | |
---|
| 5 | |
---|
| 6 | {\tt \#include $<$loggers.h$>$} |
---|
| 7 | |
---|
| 8 | Inheritance diagram for logger:\nopagebreak |
---|
| 9 | \begin{figure}[H] |
---|
| 10 | \begin{center} |
---|
| 11 | \leavevmode |
---|
| 12 | \includegraphics[width=48pt]{classlogger__inherit__graph} |
---|
| 13 | \end{center} |
---|
| 14 | \end{figure} |
---|
| 15 | \subsection*{Public Member Functions} |
---|
| 16 | \begin{CompactItemize} |
---|
| 17 | \item |
---|
| 18 | {\bf logger} ()\label{classlogger_4f753a510e00c892b38e95c2284363a6} |
---|
| 19 | |
---|
| 20 | \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item |
---|
| 21 | virtual int {\bf add} ({\bf RV} rv, string name=\char`\"{}\char`\"{})\label{classlogger_3d6c6ab580b36619c4010e3ebec55378} |
---|
| 22 | |
---|
| 23 | \begin{CompactList}\small\item\em returns an identifier which will be later needed for calling the log() function \item\end{CompactList}\item |
---|
| 24 | virtual void {\bf logit} (int id, vec v)=0\label{classlogger_efb5a59cb329f58810b09bd9cc270b78} |
---|
| 25 | |
---|
| 26 | \begin{CompactList}\small\item\em log this vector \item\end{CompactList}\item |
---|
| 27 | virtual void {\bf step} (bool final=false)=0\label{classlogger_2b86e4ad1d970cb4a0db4ded3ca59924} |
---|
| 28 | |
---|
| 29 | \begin{CompactList}\small\item\em consider this record to be complete \item\end{CompactList}\item |
---|
| 30 | virtual {\bf $\sim$logger} ()\label{classlogger_92c63a0a87392c62b9ed3c00faa9d5df} |
---|
| 31 | |
---|
| 32 | \begin{CompactList}\small\item\em for future use \item\end{CompactList}\end{CompactItemize} |
---|
| 33 | \subsection*{Protected Attributes} |
---|
| 34 | \begin{CompactItemize} |
---|
| 35 | \item |
---|
| 36 | Array$<$ {\bf RV} $>$ {\bf entries}\label{classlogger_83eea0cf4fbca59474d015f751f128a7} |
---|
| 37 | |
---|
| 38 | \begin{CompactList}\small\item\em RVs of all logged variables. \item\end{CompactList}\item |
---|
| 39 | Array$<$ string $>$ {\bf names}\label{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786} |
---|
| 40 | |
---|
| 41 | \begin{CompactList}\small\item\em Names of logged quantities, e.g. names of algorithm variants. \item\end{CompactList}\end{CompactItemize} |
---|
| 42 | |
---|
| 43 | |
---|
| 44 | \subsection{Detailed Description} |
---|
| 45 | Class for storing results (and semi-results) of an experiment. |
---|
| 46 | |
---|
| 47 | This class abstracts logging of results from implementation. This class replaces direct logging of results (e.g. to files or to global variables) by calling methods of a \doxyref{logger}{p.}{classlogger}. Specializations of this abstract class for specific storage method are designed. |
---|
| 48 | |
---|
| 49 | The documentation for this class was generated from the following file:\begin{CompactItemize} |
---|
| 50 | \item |
---|
[145] | 51 | work/git/mixpp/bdm/stat/{\bf loggers.h}\end{CompactItemize} |
---|