| 1 | \hypertarget{classmemlog}{ |
|---|
| 2 | \section{memlog Class Reference} |
|---|
| 3 | \label{classmemlog}\index{memlog@{memlog}} |
|---|
| 4 | } |
|---|
| 5 | Logging into matrices in data format in memory. |
|---|
| 6 | |
|---|
| 7 | |
|---|
| 8 | {\tt \#include $<$loggers.h$>$} |
|---|
| 9 | |
|---|
| 10 | Inheritance diagram for memlog:\nopagebreak |
|---|
| 11 | \begin{figure}[H] |
|---|
| 12 | \begin{center} |
|---|
| 13 | \leavevmode |
|---|
| 14 | \includegraphics[width=48pt]{classmemlog__inherit__graph} |
|---|
| 15 | \end{center} |
|---|
| 16 | \end{figure} |
|---|
| 17 | Collaboration diagram for memlog:\nopagebreak |
|---|
| 18 | \begin{figure}[H] |
|---|
| 19 | \begin{center} |
|---|
| 20 | \leavevmode |
|---|
| 21 | \includegraphics[width=47pt]{classmemlog__coll__graph} |
|---|
| 22 | \end{center} |
|---|
| 23 | \end{figure} |
|---|
| 24 | \subsection*{Public Member Functions} |
|---|
| 25 | \begin{CompactItemize} |
|---|
| 26 | \item |
|---|
| 27 | \hypertarget{classmemlog_e056e819c5a65d4431bfe7955b1efe97}{ |
|---|
| 28 | \hyperlink{classmemlog_e056e819c5a65d4431bfe7955b1efe97}{memlog} (int maxlen0)} |
|---|
| 29 | \label{classmemlog_e056e819c5a65d4431bfe7955b1efe97} |
|---|
| 30 | |
|---|
| 31 | \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item |
|---|
| 32 | \hypertarget{classmemlog_b081ef5acb4816e6b5fcb56c19cc7e47}{ |
|---|
| 33 | void \hyperlink{classmemlog_b081ef5acb4816e6b5fcb56c19cc7e47}{init} ()} |
|---|
| 34 | \label{classmemlog_b081ef5acb4816e6b5fcb56c19cc7e47} |
|---|
| 35 | |
|---|
| 36 | \begin{CompactList}\small\item\em Initialize storage. \item\end{CompactList}\item |
|---|
| 37 | \hypertarget{classmemlog_c97961eda9cda9f0e63c703cf21e5804}{ |
|---|
| 38 | void \hyperlink{classmemlog_c97961eda9cda9f0e63c703cf21e5804}{step} ()} |
|---|
| 39 | \label{classmemlog_c97961eda9cda9f0e63c703cf21e5804} |
|---|
| 40 | |
|---|
| 41 | \begin{CompactList}\small\item\em Shifts storage position for another time step. \item\end{CompactList}\item |
|---|
| 42 | \hypertarget{classmemlog_3974df074f1df270d56f13ade374c1be}{ |
|---|
| 43 | void \hyperlink{classmemlog_3974df074f1df270d56f13ade374c1be}{logit} (int id, const vec \&v)} |
|---|
| 44 | \label{classmemlog_3974df074f1df270d56f13ade374c1be} |
|---|
| 45 | |
|---|
| 46 | \begin{CompactList}\small\item\em log this vector \item\end{CompactList}\item |
|---|
| 47 | \hypertarget{classmemlog_65571ebbb16577b5211adbb27baf769c}{ |
|---|
| 48 | void \hyperlink{classmemlog_65571ebbb16577b5211adbb27baf769c}{itsave} (const char $\ast$fname)} |
|---|
| 49 | \label{classmemlog_65571ebbb16577b5211adbb27baf769c} |
|---|
| 50 | |
|---|
| 51 | \begin{CompactList}\small\item\em Save values into an itfile named after {\tt fname}. \item\end{CompactList}\item |
|---|
| 52 | \hypertarget{classlogger_cfb250a559b71e07a1a6aa92f2185c1b}{ |
|---|
| 53 | virtual int \hyperlink{classlogger_cfb250a559b71e07a1a6aa92f2185c1b}{add} (const \hyperlink{classRV}{RV} \&rv, string name=\char`\"{}\char`\"{})} |
|---|
| 54 | \label{classlogger_cfb250a559b71e07a1a6aa92f2185c1b} |
|---|
| 55 | |
|---|
| 56 | \begin{CompactList}\small\item\em returns an identifier which will be later needed for calling the log() function \item\end{CompactList}\item |
|---|
| 57 | \hypertarget{classlogger_51c1aa8a84a14097b51607a187ae3617}{ |
|---|
| 58 | virtual void \hyperlink{classlogger_51c1aa8a84a14097b51607a187ae3617}{finalize} ()} |
|---|
| 59 | \label{classlogger_51c1aa8a84a14097b51607a187ae3617} |
|---|
| 60 | |
|---|
| 61 | \begin{CompactList}\small\item\em Finalize storing information. \item\end{CompactList}\end{CompactItemize} |
|---|
| 62 | \subsection*{Protected Attributes} |
|---|
| 63 | \begin{CompactItemize} |
|---|
| 64 | \item |
|---|
| 65 | \hypertarget{classmemlog_4195f322897ededdac66c404b848ced3}{ |
|---|
| 66 | int \hyperlink{classmemlog_4195f322897ededdac66c404b848ced3}{maxlen}} |
|---|
| 67 | \label{classmemlog_4195f322897ededdac66c404b848ced3} |
|---|
| 68 | |
|---|
| 69 | \begin{CompactList}\small\item\em Maximum length of vectors stored in memory. \item\end{CompactList}\item |
|---|
| 70 | \hypertarget{classmemlog_3410b4c002636508c43ddcba8d394520}{ |
|---|
| 71 | int \hyperlink{classmemlog_3410b4c002636508c43ddcba8d394520}{ind}} |
|---|
| 72 | \label{classmemlog_3410b4c002636508c43ddcba8d394520} |
|---|
| 73 | |
|---|
| 74 | \begin{CompactList}\small\item\em Currect record to be written. \item\end{CompactList}\item |
|---|
| 75 | \hypertarget{classmemlog_f0f5bc7b83539ad102e8f65297852d91}{ |
|---|
| 76 | Array$<$ mat $>$ \hyperlink{classmemlog_f0f5bc7b83539ad102e8f65297852d91}{vectors}} |
|---|
| 77 | \label{classmemlog_f0f5bc7b83539ad102e8f65297852d91} |
|---|
| 78 | |
|---|
| 79 | \begin{CompactList}\small\item\em Storage. \item\end{CompactList}\item |
|---|
| 80 | \hypertarget{classlogger_83eea0cf4fbca59474d015f751f128a7}{ |
|---|
| 81 | Array$<$ \hyperlink{classRV}{RV} $>$ \hyperlink{classlogger_83eea0cf4fbca59474d015f751f128a7}{entries}} |
|---|
| 82 | \label{classlogger_83eea0cf4fbca59474d015f751f128a7} |
|---|
| 83 | |
|---|
| 84 | \begin{CompactList}\small\item\em RVs of all logged variables. \item\end{CompactList}\item |
|---|
| 85 | \hypertarget{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786}{ |
|---|
| 86 | Array$<$ string $>$ \hyperlink{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786}{names}} |
|---|
| 87 | \label{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786} |
|---|
| 88 | |
|---|
| 89 | \begin{CompactList}\small\item\em Names of logged quantities, e.g. names of algorithm variants. \item\end{CompactList}\end{CompactItemize} |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | \subsection{Detailed Description} |
|---|
| 93 | Logging into matrices in data format in memory. |
|---|
| 94 | |
|---|
| 95 | More?... |
|---|
| 96 | |
|---|
| 97 | The documentation for this class was generated from the following files:\begin{CompactItemize} |
|---|
| 98 | \item |
|---|
| 99 | work/git/mixpp/bdm/stat/\hyperlink{loggers_8h}{loggers.h}\item |
|---|
| 100 | work/git/mixpp/bdm/stat/loggers.cpp\end{CompactItemize} |
|---|
