root/doc/latex/classmemlog.tex @ 142

Revision 106, 2.8 kB (checked in by smidl, 16 years ago)

doc

  • Property svn:eol-style set to native
Line 
1\section{memlog Class Reference}
2\label{classmemlog}\index{memlog@{memlog}}
3Logging into matrices in data format in memory. 
4
5
6{\tt \#include $<$loggers.h$>$}
7
8Inheritance diagram for memlog:\nopagebreak
9\begin{figure}[H]
10\begin{center}
11\leavevmode
12\includegraphics[width=48pt]{classmemlog__inherit__graph}
13\end{center}
14\end{figure}
15Collaboration diagram for memlog:\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=47pt]{classmemlog__coll__graph}
20\end{center}
21\end{figure}
22\subsection*{Public Member Functions}
23\begin{CompactItemize}
24\item 
25{\bf memlog} (int maxlen0)\label{classmemlog_e056e819c5a65d4431bfe7955b1efe97}
26
27\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
28void {\bf init} ()\label{classmemlog_b081ef5acb4816e6b5fcb56c19cc7e47}
29
30\begin{CompactList}\small\item\em Initialize storage. \item\end{CompactList}\item 
31void {\bf step} (bool final=false)\label{classmemlog_9ebaf88cda26992f4f50aa13aeafc691}
32
33\begin{CompactList}\small\item\em consider this record to be complete \item\end{CompactList}\item 
34void {\bf logit} (int id, vec v)\label{classmemlog_8d2feeb826f7249e9104d616b5a67144}
35
36\begin{CompactList}\small\item\em log this vector \item\end{CompactList}\item 
37void \textbf{itsave} (const char $\ast$fname)\label{classmemlog_65571ebbb16577b5211adbb27baf769c}
38
39\item 
40virtual int {\bf add} ({\bf RV} rv, string name=\char`\"{}\char`\"{})\label{classlogger_3d6c6ab580b36619c4010e3ebec55378}
41
42\begin{CompactList}\small\item\em returns an identifier which will be later needed for calling the log() function \item\end{CompactList}\end{CompactItemize}
43\subsection*{Protected Attributes}
44\begin{CompactItemize}
45\item 
46int {\bf maxlen}\label{classmemlog_4195f322897ededdac66c404b848ced3}
47
48\begin{CompactList}\small\item\em Maximum length of vectors stored in memory. \item\end{CompactList}\item 
49int {\bf ind}\label{classmemlog_3410b4c002636508c43ddcba8d394520}
50
51\begin{CompactList}\small\item\em Currect record to be written. \item\end{CompactList}\item 
52Array$<$ mat $>$ {\bf vectors}\label{classmemlog_f0f5bc7b83539ad102e8f65297852d91}
53
54\begin{CompactList}\small\item\em Storage. \item\end{CompactList}\item 
55Array$<$ {\bf RV} $>$ {\bf entries}\label{classlogger_83eea0cf4fbca59474d015f751f128a7}
56
57\begin{CompactList}\small\item\em RVs of all logged variables. \item\end{CompactList}\item 
58Array$<$ string $>$ {\bf names}\label{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786}
59
60\begin{CompactList}\small\item\em Names of logged quantities, e.g. names of algorithm variants. \item\end{CompactList}\end{CompactItemize}
61
62
63\subsection{Detailed Description}
64Logging into matrices in data format in memory.
65
66More?...
67
68The documentation for this class was generated from the following files:\begin{CompactItemize}
69\item 
70work/mixpp/bdm/stat/{\bf loggers.h}\item 
71work/mixpp/bdm/stat/loggers.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.