root/doc/latex/classbdm_1_1memlog.tex @ 261

Revision 261, 4.8 kB (checked in by smidl, 16 years ago)

doc

Line 
1\hypertarget{classbdm_1_1memlog}{
2\section{bdm::memlog Class Reference}
3\label{classbdm_1_1memlog}\index{bdm::memlog@{bdm::memlog}}
4}
5Logging into matrices in data format in memory. 
6
7
8{\tt \#include $<$loggers.h$>$}
9
10Inheritance diagram for bdm::memlog:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=64pt]{classbdm_1_1memlog__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::memlog:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=64pt]{classbdm_1_1memlog__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hypertarget{classbdm_1_1memlog_e761799874d28bbfc4edc121be8c0a86}{
28\hyperlink{classbdm_1_1memlog_e761799874d28bbfc4edc121be8c0a86}{memlog} (int maxlen0)}
29\label{classbdm_1_1memlog_e761799874d28bbfc4edc121be8c0a86}
30
31\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
32\hypertarget{classbdm_1_1memlog_d3a8b007f3540523ff3f9910d9089391}{
33void \hyperlink{classbdm_1_1memlog_d3a8b007f3540523ff3f9910d9089391}{init} ()}
34\label{classbdm_1_1memlog_d3a8b007f3540523ff3f9910d9089391}
35
36\begin{CompactList}\small\item\em Initialize storage. \item\end{CompactList}\item 
37\hypertarget{classbdm_1_1memlog_69964f0472e53098528ee41507bdfc77}{
38void \hyperlink{classbdm_1_1memlog_69964f0472e53098528ee41507bdfc77}{step} ()}
39\label{classbdm_1_1memlog_69964f0472e53098528ee41507bdfc77}
40
41\begin{CompactList}\small\item\em Shifts storage position for another time step. \item\end{CompactList}\item 
42\hypertarget{classbdm_1_1memlog_364e58c5d7058776c2a9cfa7d58dad6d}{
43void \hyperlink{classbdm_1_1memlog_364e58c5d7058776c2a9cfa7d58dad6d}{logit} (int id, const vec \&v)}
44\label{classbdm_1_1memlog_364e58c5d7058776c2a9cfa7d58dad6d}
45
46\begin{CompactList}\small\item\em log this vector \item\end{CompactList}\item 
47\hypertarget{classbdm_1_1memlog_6a74b7a3d889607391594279112aef1f}{
48void \hyperlink{classbdm_1_1memlog_6a74b7a3d889607391594279112aef1f}{itsave} (const char $\ast$fname)}
49\label{classbdm_1_1memlog_6a74b7a3d889607391594279112aef1f}
50
51\begin{CompactList}\small\item\em Save values into an itfile named after {\tt fname}. \item\end{CompactList}\item 
52\hypertarget{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}{
53virtual int \hyperlink{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}{add} (const \hyperlink{classbdm_1_1RV}{RV} \&rv, string name=\char`\"{}\char`\"{})}
54\label{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}
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{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d}{
58virtual void \hyperlink{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d}{finalize} ()}
59\label{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d}
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{classbdm_1_1memlog_a690ebd91430b5973855c9b4c9cf1b1d}{
66int \hyperlink{classbdm_1_1memlog_a690ebd91430b5973855c9b4c9cf1b1d}{maxlen}}
67\label{classbdm_1_1memlog_a690ebd91430b5973855c9b4c9cf1b1d}
68
69\begin{CompactList}\small\item\em Maximum length of vectors stored in memory. \item\end{CompactList}\item 
70\hypertarget{classbdm_1_1memlog_70cec1d3549a82796ad7b6f0d07a4570}{
71int \hyperlink{classbdm_1_1memlog_70cec1d3549a82796ad7b6f0d07a4570}{ind}}
72\label{classbdm_1_1memlog_70cec1d3549a82796ad7b6f0d07a4570}
73
74\begin{CompactList}\small\item\em Currect record to be written. \item\end{CompactList}\item 
75\hypertarget{classbdm_1_1memlog_1fed143162f2de6ef1c1b6557964f24e}{
76Array$<$ mat $>$ \hyperlink{classbdm_1_1memlog_1fed143162f2de6ef1c1b6557964f24e}{vectors}}
77\label{classbdm_1_1memlog_1fed143162f2de6ef1c1b6557964f24e}
78
79\begin{CompactList}\small\item\em Storage. \item\end{CompactList}\item 
80\hypertarget{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}{
81Array$<$ \hyperlink{classbdm_1_1RV}{RV} $>$ \hyperlink{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}{entries}}
82\label{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}
83
84\begin{CompactList}\small\item\em RVs of all logged variables. \item\end{CompactList}\item 
85\hypertarget{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}{
86Array$<$ string $>$ \hyperlink{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}{names}}
87\label{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}
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}
93Logging into matrices in data format in memory.
94
95More?...
96
97The documentation for this class was generated from the following files:\begin{CompactItemize}
98\item 
99\hyperlink{loggers_8h}{loggers.h}\item 
100loggers.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.