root/doc/latex/classbdm_1_1memlog.tex @ 280

\hypertarget{classbdm_1_1memlog}{
\section{bdm::memlog Class Reference}
\label{classbdm_1_1memlog}\index{bdm::memlog@{bdm::memlog}}
}
{\tt \#include $<$loggers.h$>$}

Inheritance diagram for bdm::memlog::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4cm]{classbdm_1_1memlog}
\end{center}
\end{figure}


\subsection{Detailed Description}
Logging into matrices in data format in memory. 

More?... \subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1memlog_e761799874d28bbfc4edc121be8c0a86}{
\hyperlink{classbdm_1_1memlog_e761799874d28bbfc4edc121be8c0a86}{memlog} (int maxlen0)}
\label{classbdm_1_1memlog_e761799874d28bbfc4edc121be8c0a86}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1memlog_d3a8b007f3540523ff3f9910d9089391}{
void \hyperlink{classbdm_1_1memlog_d3a8b007f3540523ff3f9910d9089391}{init} ()}
\label{classbdm_1_1memlog_d3a8b007f3540523ff3f9910d9089391}

\begin{CompactList}\small\item\em Initialize storage. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1memlog_69964f0472e53098528ee41507bdfc77}{
void \hyperlink{classbdm_1_1memlog_69964f0472e53098528ee41507bdfc77}{step} ()}
\label{classbdm_1_1memlog_69964f0472e53098528ee41507bdfc77}

\begin{CompactList}\small\item\em Shifts storage position for another time step. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1memlog_364e58c5d7058776c2a9cfa7d58dad6d}{
void \hyperlink{classbdm_1_1memlog_364e58c5d7058776c2a9cfa7d58dad6d}{logit} (int id, const vec \&v)}
\label{classbdm_1_1memlog_364e58c5d7058776c2a9cfa7d58dad6d}

\begin{CompactList}\small\item\em log this vector \item\end{CompactList}\item 
\hypertarget{classbdm_1_1memlog_6a74b7a3d889607391594279112aef1f}{
void \hyperlink{classbdm_1_1memlog_6a74b7a3d889607391594279112aef1f}{itsave} (const char $\ast$fname)}
\label{classbdm_1_1memlog_6a74b7a3d889607391594279112aef1f}

\begin{CompactList}\small\item\em Save values into an itfile named after {\tt fname}. \item\end{CompactList}\item 
virtual int \hyperlink{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}{add} (const \hyperlink{classbdm_1_1RV}{RV} \&rv, string name=\char`\"{}\char`\"{})
\item 
\hypertarget{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d}{
virtual void \hyperlink{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d}{finalize} ()}
\label{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d}

\begin{CompactList}\small\item\em Finalize storing information. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
\hypertarget{classbdm_1_1memlog_a690ebd91430b5973855c9b4c9cf1b1d}{
int \hyperlink{classbdm_1_1memlog_a690ebd91430b5973855c9b4c9cf1b1d}{maxlen}}
\label{classbdm_1_1memlog_a690ebd91430b5973855c9b4c9cf1b1d}

\begin{CompactList}\small\item\em Maximum length of vectors stored in memory. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1memlog_70cec1d3549a82796ad7b6f0d07a4570}{
int \hyperlink{classbdm_1_1memlog_70cec1d3549a82796ad7b6f0d07a4570}{ind}}
\label{classbdm_1_1memlog_70cec1d3549a82796ad7b6f0d07a4570}

\begin{CompactList}\small\item\em Currect record to be written. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1memlog_1fed143162f2de6ef1c1b6557964f24e}{
Array$<$ mat $>$ \hyperlink{classbdm_1_1memlog_1fed143162f2de6ef1c1b6557964f24e}{vectors}}
\label{classbdm_1_1memlog_1fed143162f2de6ef1c1b6557964f24e}

\begin{CompactList}\small\item\em Storage. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}{
Array$<$ \hyperlink{classbdm_1_1RV}{RV} $>$ \hyperlink{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}{entries}}
\label{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}

\begin{CompactList}\small\item\em RVs of all logged variables. \item\end{CompactList}\item 
\hypertarget{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}{
Array$<$ string $>$ \hyperlink{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}{names}}
\label{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}

\begin{CompactList}\small\item\em Names of logged quantities, e.g. names of algorithm variants. \item\end{CompactList}\end{CompactItemize}


\subsection{Member Function Documentation}
\hypertarget{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}{
\index{bdm::memlog@{bdm::memlog}!add@{add}}
\index{add@{add}!bdm::memlog@{bdm::memlog}}
\subsubsection[add]{\setlength{\rightskip}{0pt plus 5cm}virtual int bdm::logger::add (const {\bf RV} \& {\em rv}, \/  string {\em name} = {\tt \char`\"{}\char`\"{}})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual, inherited\mbox{]}}}}
\label{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}


returns an identifier which will be later needed for calling the {\tt \hyperlink{classbdm_1_1logger_397c014b0aaf3581516e2a105d26a5c9}{logit()}} function For empty \hyperlink{classbdm_1_1RV}{RV} it returns -1, this entry will be ignored by {\tt \hyperlink{classbdm_1_1logger_397c014b0aaf3581516e2a105d26a5c9}{logit()}}. 

References bdm::logger::entries, and bdm::logger::names.

Referenced by pmsmDS::log\_\-add(), bdm::ArxDS::log\_\-add(), and bdm::DS::log\_\-add().

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
\hyperlink{loggers_8h}{loggers.h}\item 
loggers.cpp\end{CompactItemize}