Show
Ignore:
Timestamp:
09/24/08 13:31:03 (16 years ago)
Author:
smidl
Message:

Latex doc

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • doc/latex/classmemlog.tex

    r162 r172  
     1\hypertarget{classmemlog}{ 
    12\section{memlog Class Reference} 
    23\label{classmemlog}\index{memlog@{memlog}} 
     4} 
    35Logging into matrices in data format in memory.   
    46 
    … …  
    2325\begin{CompactItemize} 
    2426\item  
    25 {\bf memlog} (int maxlen0)\label{classmemlog_e056e819c5a65d4431bfe7955b1efe97} 
     27\hypertarget{classmemlog_e056e819c5a65d4431bfe7955b1efe97}{ 
     28\hyperlink{classmemlog_e056e819c5a65d4431bfe7955b1efe97}{memlog} (int maxlen0)} 
     29\label{classmemlog_e056e819c5a65d4431bfe7955b1efe97} 
    2630 
    2731\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item  
    28 void {\bf init} ()\label{classmemlog_b081ef5acb4816e6b5fcb56c19cc7e47} 
     32\hypertarget{classmemlog_b081ef5acb4816e6b5fcb56c19cc7e47}{ 
     33void \hyperlink{classmemlog_b081ef5acb4816e6b5fcb56c19cc7e47}{init} ()} 
     34\label{classmemlog_b081ef5acb4816e6b5fcb56c19cc7e47} 
    2935 
    3036\begin{CompactList}\small\item\em Initialize storage. \item\end{CompactList}\item  
    31 void {\bf step} ()\label{classmemlog_c97961eda9cda9f0e63c703cf21e5804} 
     37\hypertarget{classmemlog_c97961eda9cda9f0e63c703cf21e5804}{ 
     38void \hyperlink{classmemlog_c97961eda9cda9f0e63c703cf21e5804}{step} ()} 
     39\label{classmemlog_c97961eda9cda9f0e63c703cf21e5804} 
    3240 
    3341\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} 
     42\hypertarget{classmemlog_8d2feeb826f7249e9104d616b5a67144}{ 
     43void \hyperlink{classmemlog_8d2feeb826f7249e9104d616b5a67144}{logit} (int id, vec v)} 
     44\label{classmemlog_8d2feeb826f7249e9104d616b5a67144} 
    3545 
    3646\begin{CompactList}\small\item\em log this vector \item\end{CompactList}\item  
    37 void {\bf itsave} (const char $\ast$fname)\label{classmemlog_65571ebbb16577b5211adbb27baf769c} 
     47\hypertarget{classmemlog_65571ebbb16577b5211adbb27baf769c}{ 
     48void \hyperlink{classmemlog_65571ebbb16577b5211adbb27baf769c}{itsave} (const char $\ast$fname)} 
     49\label{classmemlog_65571ebbb16577b5211adbb27baf769c} 
    3850 
    3951\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} 
     52\hypertarget{classlogger_cfb250a559b71e07a1a6aa92f2185c1b}{ 
     53virtual int \hyperlink{classlogger_cfb250a559b71e07a1a6aa92f2185c1b}{add} (const \hyperlink{classRV}{RV} \&rv, string name=\char`\"{}\char`\"{})} 
     54\label{classlogger_cfb250a559b71e07a1a6aa92f2185c1b} 
    4155 
    4256\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} 
     57\hypertarget{classlogger_51c1aa8a84a14097b51607a187ae3617}{ 
     58virtual void \hyperlink{classlogger_51c1aa8a84a14097b51607a187ae3617}{finalize} ()} 
     59\label{classlogger_51c1aa8a84a14097b51607a187ae3617} 
    4460 
    4561\begin{CompactList}\small\item\em Finalize storing information. \item\end{CompactList}\end{CompactItemize} 
    … …  
    4763\begin{CompactItemize} 
    4864\item  
    49 int {\bf maxlen}\label{classmemlog_4195f322897ededdac66c404b848ced3} 
     65\hypertarget{classmemlog_4195f322897ededdac66c404b848ced3}{ 
     66int \hyperlink{classmemlog_4195f322897ededdac66c404b848ced3}{maxlen}} 
     67\label{classmemlog_4195f322897ededdac66c404b848ced3} 
    5068 
    5169\begin{CompactList}\small\item\em Maximum length of vectors stored in memory. \item\end{CompactList}\item  
    52 int {\bf ind}\label{classmemlog_3410b4c002636508c43ddcba8d394520} 
     70\hypertarget{classmemlog_3410b4c002636508c43ddcba8d394520}{ 
     71int \hyperlink{classmemlog_3410b4c002636508c43ddcba8d394520}{ind}} 
     72\label{classmemlog_3410b4c002636508c43ddcba8d394520} 
    5373 
    5474\begin{CompactList}\small\item\em Currect record to be written. \item\end{CompactList}\item  
    55 Array$<$ mat $>$ {\bf vectors}\label{classmemlog_f0f5bc7b83539ad102e8f65297852d91} 
     75\hypertarget{classmemlog_f0f5bc7b83539ad102e8f65297852d91}{ 
     76Array$<$ mat $>$ \hyperlink{classmemlog_f0f5bc7b83539ad102e8f65297852d91}{vectors}} 
     77\label{classmemlog_f0f5bc7b83539ad102e8f65297852d91} 
    5678 
    5779\begin{CompactList}\small\item\em Storage. \item\end{CompactList}\item  
    58 Array$<$ {\bf RV} $>$ {\bf entries}\label{classlogger_83eea0cf4fbca59474d015f751f128a7} 
     80\hypertarget{classlogger_83eea0cf4fbca59474d015f751f128a7}{ 
     81Array$<$ \hyperlink{classRV}{RV} $>$ \hyperlink{classlogger_83eea0cf4fbca59474d015f751f128a7}{entries}} 
     82\label{classlogger_83eea0cf4fbca59474d015f751f128a7} 
    5983 
    6084\begin{CompactList}\small\item\em RVs of all logged variables. \item\end{CompactList}\item  
    61 Array$<$ string $>$ {\bf names}\label{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786} 
     85\hypertarget{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786}{ 
     86Array$<$ string $>$ \hyperlink{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786}{names}} 
     87\label{classlogger_39cb79e839ca8f8bb9dcbc8c5b9c7786} 
    6288 
    6389\begin{CompactList}\small\item\em Names of logged quantities, e.g. names of algorithm variants. \item\end{CompactList}\end{CompactItemize} 
    … …  
    7197The documentation for this class was generated from the following files:\begin{CompactItemize} 
    7298\item  
    73 work/git/mixpp/bdm/stat/{\bf loggers.h}\item  
     99work/git/mixpp/bdm/stat/\hyperlink{loggers_8h}{loggers.h}\item  
    74100work/git/mixpp/bdm/stat/loggers.cpp\end{CompactItemize}