Changeset 172 for doc/latex/classdirfilelog.tex
- Timestamp:
- 09/24/08 13:31:03 (16 years ago)
- Files:
-
- 1 modified
-
doc/latex/classdirfilelog.tex (modified) (6 diffs)
Legend:
- Unmodified
- Added
- Removed
-
doc/latex/classdirfilelog.tex
r162 r172 1 \hypertarget{classdirfilelog}{ 1 2 \section{dirfilelog Class Reference} 2 3 \label{classdirfilelog}\index{dirfilelog@{dirfilelog}} 4 } 3 5 Logging into dirfile with buffer in memory. 4 6 … … 23 25 \begin{CompactItemize} 24 26 \item 25 {\bfdirfilelog} (std::string dirname0, int maxlen0)27 \hyperlink{classdirfilelog_802eeb6fc4ebf11d97638fd5dc651c68}{dirfilelog} (std::string dirname0, int maxlen0) 26 28 \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 27 void {\bf init} ()\label{classdirfilelog_afeaebe003110f9db1ac43edf8e53a92} 29 \hypertarget{classdirfilelog_afeaebe003110f9db1ac43edf8e53a92}{ 30 void \hyperlink{classdirfilelog_afeaebe003110f9db1ac43edf8e53a92}{init} ()} 31 \label{classdirfilelog_afeaebe003110f9db1ac43edf8e53a92} 28 32 29 33 \begin{CompactList}\small\item\em Initialize storage. \item\end{CompactList}\item 30 void {\bf step} ()\label{classdirfilelog_f5fe9483a041591bfe6f3d6393b02aa7} 34 \hypertarget{classdirfilelog_f5fe9483a041591bfe6f3d6393b02aa7}{ 35 void \hyperlink{classdirfilelog_f5fe9483a041591bfe6f3d6393b02aa7}{step} ()} 36 \label{classdirfilelog_f5fe9483a041591bfe6f3d6393b02aa7} 31 37 32 38 \begin{CompactList}\small\item\em Shifts storage position for another time step. \item\end{CompactList}\item 33 void {\bf finalize} ()\label{classdirfilelog_4d671baf6f88444d7fe25a5b8a80834a} 39 \hypertarget{classdirfilelog_4d671baf6f88444d7fe25a5b8a80834a}{ 40 void \hyperlink{classdirfilelog_4d671baf6f88444d7fe25a5b8a80834a}{finalize} ()} 41 \label{classdirfilelog_4d671baf6f88444d7fe25a5b8a80834a} 34 42 35 43 \begin{CompactList}\small\item\em Finalize storing information. \item\end{CompactList}\item 36 void {\bfwrite\_\-buffers} (int Len)44 void \hyperlink{classdirfilelog_bd95cdb46af194245f88a7b4bf4c66c7}{write\_\-buffers} (int Len) 37 45 \begin{CompactList}\small\item\em Write memory storage to disk. \item\end{CompactList}\item 38 void {\bf logit} (int id, vec v)\label{classmemlog_8d2feeb826f7249e9104d616b5a67144} 46 \hypertarget{classmemlog_8d2feeb826f7249e9104d616b5a67144}{ 47 void \hyperlink{classmemlog_8d2feeb826f7249e9104d616b5a67144}{logit} (int id, vec v)} 48 \label{classmemlog_8d2feeb826f7249e9104d616b5a67144} 39 49 40 50 \begin{CompactList}\small\item\em log this vector \item\end{CompactList}\item 41 void {\bf itsave} (const char $\ast$fname)\label{classmemlog_65571ebbb16577b5211adbb27baf769c} 51 \hypertarget{classmemlog_65571ebbb16577b5211adbb27baf769c}{ 52 void \hyperlink{classmemlog_65571ebbb16577b5211adbb27baf769c}{itsave} (const char $\ast$fname)} 53 \label{classmemlog_65571ebbb16577b5211adbb27baf769c} 42 54 43 55 \begin{CompactList}\small\item\em Save values into an itfile named after {\tt fname}. \item\end{CompactList}\item 44 virtual int {\bf add} (const {\bf RV} \&rv, string name=\char`\"{}\char`\"{})\label{classlogger_cfb250a559b71e07a1a6aa92f2185c1b} 56 \hypertarget{classlogger_cfb250a559b71e07a1a6aa92f2185c1b}{ 57 virtual int \hyperlink{classlogger_cfb250a559b71e07a1a6aa92f2185c1b}{add} (const \hyperlink{classRV}{RV} \&rv, string name=\char`\"{}\char`\"{})} 58 \label{classlogger_cfb250a559b71e07a1a6aa92f2185c1b} 45 59 46 60 \begin{CompactList}\small\item\em returns an identifier which will be later needed for calling the log() function \item\end{CompactList}\end{CompactItemize} … … 48 62 \begin{CompactItemize} 49 63 \item 50 string {\bf dirname}\label{classdirfilelog_cba5ff1f74ed22910ed7d63aadf21771} 64 \hypertarget{classdirfilelog_cba5ff1f74ed22910ed7d63aadf21771}{ 65 string \hyperlink{classdirfilelog_cba5ff1f74ed22910ed7d63aadf21771}{dirname}} 66 \label{classdirfilelog_cba5ff1f74ed22910ed7d63aadf21771} 51 67 52 68 \begin{CompactList}\small\item\em name of the directory \item\end{CompactList}\item 53 Array$<$ string $>$ {\bf scalarnames}\label{classdirfilelog_854b7e7cc4cb40542b4a3ea06d915772} 69 \hypertarget{classdirfilelog_854b7e7cc4cb40542b4a3ea06d915772}{ 70 Array$<$ string $>$ \hyperlink{classdirfilelog_854b7e7cc4cb40542b4a3ea06d915772}{scalarnames}} 71 \label{classdirfilelog_854b7e7cc4cb40542b4a3ea06d915772} 54 72 55 73 \begin{CompactList}\small\item\em Automatically generated. \item\end{CompactList}\item 56 int {\bf maxlen}\label{classmemlog_4195f322897ededdac66c404b848ced3} 74 \hypertarget{classmemlog_4195f322897ededdac66c404b848ced3}{ 75 int \hyperlink{classmemlog_4195f322897ededdac66c404b848ced3}{maxlen}} 76 \label{classmemlog_4195f322897ededdac66c404b848ced3} 57 77 58 78 \begin{CompactList}\small\item\em Maximum length of vectors stored in memory. \item\end{CompactList}\item 59 int {\bf ind}\label{classmemlog_3410b4c002636508c43ddcba8d394520} 79 \hypertarget{classmemlog_3410b4c002636508c43ddcba8d394520}{ 80 int \hyperlink{classmemlog_3410b4c002636508c43ddcba8d394520}{ind}} 81 \label{classmemlog_3410b4c002636508c43ddcba8d394520} 60 82 61 83 \begin{CompactList}\small\item\em Currect record to be written. \item\end{CompactList}\item 62 Array$<$ mat $>$ {\bf vectors}\label{classmemlog_f0f5bc7b83539ad102e8f65297852d91} 84 \hypertarget{classmemlog_f0f5bc7b83539ad102e8f65297852d91}{ 85 Array$<$ mat $>$ \hyperlink{classmemlog_f0f5bc7b83539ad102e8f65297852d91}{vectors}} 86 \label{classmemlog_f0f5bc7b83539ad102e8f65297852d91} 63 87 64 88 \begin{CompactList}\small\item\em Storage. \item\end{CompactList}\item 65 Array$<$ {\bf RV} $>$ {\bf entries}\label{classlogger_83eea0cf4fbca59474d015f751f128a7} 89 \hypertarget{classlogger_83eea0cf4fbca59474d015f751f128a7}{ 90 Array$<$ \hyperlink{classRV}{RV} $>$ \hyperlink{classlogger_83eea0cf4fbca59474d015f751f128a7}{entries}} 91 \label{classlogger_83eea0cf4fbca59474d015f751f128a7} 66 92 67 93 \begin{CompactList}\small\item\em RVs of all logged variables. \item\end{CompactList}\item 68 Array$<$ string $>$ {\bf names}\label{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786} 94 \hypertarget{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786}{ 95 Array$<$ string $>$ \hyperlink{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786}{names}} 96 \label{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786} 69 97 70 98 \begin{CompactList}\small\item\em Names of logged quantities, e.g. names of algorithm variants. \item\end{CompactList}\end{CompactItemize} … … 79 107 80 108 \subsection{Constructor \& Destructor Documentation} 109 \hypertarget{classdirfilelog_802eeb6fc4ebf11d97638fd5dc651c68}{ 81 110 \index{dirfilelog@{dirfilelog}!dirfilelog@{dirfilelog}} 82 111 \index{dirfilelog@{dirfilelog}!dirfilelog@{dirfilelog}} 83 \subsubsection[dirfilelog]{\setlength{\rightskip}{0pt plus 5cm}dirfilelog::dirfilelog (std::string {\em dirname0}, \/ int {\em maxlen0})\hspace{0.3cm}{\tt [inline]}}\label{classdirfilelog_802eeb6fc4ebf11d97638fd5dc651c68} 112 \subsubsection[dirfilelog]{\setlength{\rightskip}{0pt plus 5cm}dirfilelog::dirfilelog (std::string {\em dirname0}, \/ int {\em maxlen0})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} 113 \label{classdirfilelog_802eeb6fc4ebf11d97638fd5dc651c68} 84 114 85 115 … … 94 124 95 125 \subsection{Member Function Documentation} 126 \hypertarget{classdirfilelog_bd95cdb46af194245f88a7b4bf4c66c7}{ 96 127 \index{dirfilelog@{dirfilelog}!write\_\-buffers@{write\_\-buffers}} 97 128 \index{write\_\-buffers@{write\_\-buffers}!dirfilelog@{dirfilelog}} 98 \subsubsection[write\_\-buffers]{\setlength{\rightskip}{0pt plus 5cm}void dirfilelog::write\_\-buffers (int {\em Len})}\label{classdirfilelog_bd95cdb46af194245f88a7b4bf4c66c7} 129 \subsubsection[write\_\-buffers]{\setlength{\rightskip}{0pt plus 5cm}void dirfilelog::write\_\-buffers (int {\em Len})}} 130 \label{classdirfilelog_bd95cdb46af194245f88a7b4bf4c66c7} 99 131 100 132 … … 114 146 The documentation for this class was generated from the following files:\begin{CompactItemize} 115 147 \item 116 work/git/mixpp/bdm/stat/ {\bfloggers.h}\item148 work/git/mixpp/bdm/stat/\hyperlink{loggers_8h}{loggers.h}\item 117 149 work/git/mixpp/bdm/stat/loggers.cpp\end{CompactItemize}
