1 | \section{memlog Class Reference} |
---|
2 | \label{classmemlog}\index{memlog@{memlog}} |
---|
3 | Logging into matrices in data format in memory. |
---|
4 | |
---|
5 | |
---|
6 | {\tt \#include $<$loggers.h$>$} |
---|
7 | |
---|
8 | Inheritance 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} |
---|
15 | Collaboration 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 |
---|
28 | void {\bf init} ()\label{classmemlog_b081ef5acb4816e6b5fcb56c19cc7e47} |
---|
29 | |
---|
30 | \begin{CompactList}\small\item\em Initialize storage. \item\end{CompactList}\item |
---|
31 | void {\bf step} ()\label{classmemlog_c97961eda9cda9f0e63c703cf21e5804} |
---|
32 | |
---|
33 | \begin{CompactList}\small\item\em Shifts storage position for another time step. \item\end{CompactList}\item |
---|
34 | void {\bf logit} (int id, vec v)\label{classmemlog_8d2feeb826f7249e9104d616b5a67144} |
---|
35 | |
---|
36 | \begin{CompactList}\small\item\em log this vector \item\end{CompactList}\item |
---|
37 | void {\bf itsave} (const char $\ast$fname)\label{classmemlog_65571ebbb16577b5211adbb27baf769c} |
---|
38 | |
---|
39 | \begin{CompactList}\small\item\em Save values into an itfile named after {\tt fname}. \item\end{CompactList}\item |
---|
40 | virtual int {\bf add} (const {\bf RV} \&rv, string name=\char`\"{}\char`\"{})\label{classlogger_cfb250a559b71e07a1a6aa92f2185c1b} |
---|
41 | |
---|
42 | \begin{CompactList}\small\item\em returns an identifier which will be later needed for calling the log() function \item\end{CompactList}\item |
---|
43 | virtual void {\bf finalize} ()\label{classlogger_51c1aa8a84a14097b51607a187ae3617} |
---|
44 | |
---|
45 | \begin{CompactList}\small\item\em Finalize storing information. \item\end{CompactList}\end{CompactItemize} |
---|
46 | \subsection*{Protected Attributes} |
---|
47 | \begin{CompactItemize} |
---|
48 | \item |
---|
49 | int {\bf maxlen}\label{classmemlog_4195f322897ededdac66c404b848ced3} |
---|
50 | |
---|
51 | \begin{CompactList}\small\item\em Maximum length of vectors stored in memory. \item\end{CompactList}\item |
---|
52 | int {\bf ind}\label{classmemlog_3410b4c002636508c43ddcba8d394520} |
---|
53 | |
---|
54 | \begin{CompactList}\small\item\em Currect record to be written. \item\end{CompactList}\item |
---|
55 | Array$<$ mat $>$ {\bf vectors}\label{classmemlog_f0f5bc7b83539ad102e8f65297852d91} |
---|
56 | |
---|
57 | \begin{CompactList}\small\item\em Storage. \item\end{CompactList}\item |
---|
58 | Array$<$ {\bf RV} $>$ {\bf entries}\label{classlogger_83eea0cf4fbca59474d015f751f128a7} |
---|
59 | |
---|
60 | \begin{CompactList}\small\item\em RVs of all logged variables. \item\end{CompactList}\item |
---|
61 | Array$<$ string $>$ {\bf names}\label{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786} |
---|
62 | |
---|
63 | \begin{CompactList}\small\item\em Names of logged quantities, e.g. names of algorithm variants. \item\end{CompactList}\end{CompactItemize} |
---|
64 | |
---|
65 | |
---|
66 | \subsection{Detailed Description} |
---|
67 | Logging into matrices in data format in memory. |
---|
68 | |
---|
69 | More?... |
---|
70 | |
---|
71 | The documentation for this class was generated from the following files:\begin{CompactItemize} |
---|
72 | \item |
---|
73 | work/git/mixpp/bdm/stat/{\bf loggers.h}\item |
---|
74 | work/git/mixpp/bdm/stat/loggers.cpp\end{CompactItemize} |
---|