| 1 | \hypertarget{classbdm_1_1logger}{ |
|---|
| 2 | \section{bdm::logger Class Reference} |
|---|
| 3 | \label{classbdm_1_1logger}\index{bdm::logger@{bdm::logger}} |
|---|
| 4 | } |
|---|
| 5 | DataLink is a connection between two data vectors Up and Down. |
|---|
| 6 | |
|---|
| 7 | |
|---|
| 8 | {\tt \#include $<$libBM.h$>$} |
|---|
| 9 | |
|---|
| 10 | Inheritance diagram for bdm::logger:\nopagebreak |
|---|
| 11 | \begin{figure}[H] |
|---|
| 12 | \begin{center} |
|---|
| 13 | \leavevmode |
|---|
| 14 | \includegraphics[width=64pt]{classbdm_1_1logger__inherit__graph} |
|---|
| 15 | \end{center} |
|---|
| 16 | \end{figure} |
|---|
| 17 | Collaboration diagram for bdm::logger:\nopagebreak |
|---|
| 18 | \begin{figure}[H] |
|---|
| 19 | \begin{center} |
|---|
| 20 | \leavevmode |
|---|
| 21 | \includegraphics[width=64pt]{classbdm_1_1logger__coll__graph} |
|---|
| 22 | \end{center} |
|---|
| 23 | \end{figure} |
|---|
| 24 | \subsection*{Public Member Functions} |
|---|
| 25 | \begin{CompactItemize} |
|---|
| 26 | \item |
|---|
| 27 | \hypertarget{classbdm_1_1logger_f9c2fe7db5ddbda0098a4a5bd2c29fbf}{ |
|---|
| 28 | \hyperlink{classbdm_1_1logger_f9c2fe7db5ddbda0098a4a5bd2c29fbf}{logger} ()} |
|---|
| 29 | \label{classbdm_1_1logger_f9c2fe7db5ddbda0098a4a5bd2c29fbf} |
|---|
| 30 | |
|---|
| 31 | \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item |
|---|
| 32 | \hypertarget{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}{ |
|---|
| 33 | virtual int \hyperlink{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}{add} (const \hyperlink{classbdm_1_1RV}{RV} \&rv, string name=\char`\"{}\char`\"{})} |
|---|
| 34 | \label{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1} |
|---|
| 35 | |
|---|
| 36 | \begin{CompactList}\small\item\em returns an identifier which will be later needed for calling the log() function \item\end{CompactList}\item |
|---|
| 37 | \hypertarget{classbdm_1_1logger_397c014b0aaf3581516e2a105d26a5c9}{ |
|---|
| 38 | virtual void \hyperlink{classbdm_1_1logger_397c014b0aaf3581516e2a105d26a5c9}{logit} (int id, const vec \&v)=0} |
|---|
| 39 | \label{classbdm_1_1logger_397c014b0aaf3581516e2a105d26a5c9} |
|---|
| 40 | |
|---|
| 41 | \begin{CompactList}\small\item\em log this vector \item\end{CompactList}\item |
|---|
| 42 | \hypertarget{classbdm_1_1logger_4f31c03578a7b9b30d8b1f8c338a37e8}{ |
|---|
| 43 | virtual void \hyperlink{classbdm_1_1logger_4f31c03578a7b9b30d8b1f8c338a37e8}{step} ()=0} |
|---|
| 44 | \label{classbdm_1_1logger_4f31c03578a7b9b30d8b1f8c338a37e8} |
|---|
| 45 | |
|---|
| 46 | \begin{CompactList}\small\item\em Shifts storage position for another time step. \item\end{CompactList}\item |
|---|
| 47 | \hypertarget{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d}{ |
|---|
| 48 | virtual void \hyperlink{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d}{finalize} ()} |
|---|
| 49 | \label{classbdm_1_1logger_0e3fc7d13e23a8f71fc7c8a5ea68559d} |
|---|
| 50 | |
|---|
| 51 | \begin{CompactList}\small\item\em Finalize storing information. \item\end{CompactList}\item |
|---|
| 52 | \hypertarget{classbdm_1_1logger_cd6291a73491f755dc7bc88d022eb2fc}{ |
|---|
| 53 | virtual void \hyperlink{classbdm_1_1logger_cd6291a73491f755dc7bc88d022eb2fc}{init} ()} |
|---|
| 54 | \label{classbdm_1_1logger_cd6291a73491f755dc7bc88d022eb2fc} |
|---|
| 55 | |
|---|
| 56 | \begin{CompactList}\small\item\em Initialize the storage. \item\end{CompactList}\item |
|---|
| 57 | \hypertarget{classbdm_1_1logger_f2ade56238a5d408e65a77c53f516448}{ |
|---|
| 58 | virtual \hyperlink{classbdm_1_1logger_f2ade56238a5d408e65a77c53f516448}{$\sim$logger} ()} |
|---|
| 59 | \label{classbdm_1_1logger_f2ade56238a5d408e65a77c53f516448} |
|---|
| 60 | |
|---|
| 61 | \begin{CompactList}\small\item\em for future use \item\end{CompactList}\end{CompactItemize} |
|---|
| 62 | \subsection*{Protected Attributes} |
|---|
| 63 | \begin{CompactItemize} |
|---|
| 64 | \item |
|---|
| 65 | \hypertarget{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}{ |
|---|
| 66 | Array$<$ \hyperlink{classbdm_1_1RV}{RV} $>$ \hyperlink{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}{entries}} |
|---|
| 67 | \label{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f} |
|---|
| 68 | |
|---|
| 69 | \begin{CompactList}\small\item\em RVs of all logged variables. \item\end{CompactList}\item |
|---|
| 70 | \hypertarget{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}{ |
|---|
| 71 | Array$<$ string $>$ \hyperlink{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}{names}} |
|---|
| 72 | \label{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02} |
|---|
| 73 | |
|---|
| 74 | \begin{CompactList}\small\item\em Names of logged quantities, e.g. names of algorithm variants. \item\end{CompactList}\end{CompactItemize} |
|---|
| 75 | |
|---|
| 76 | |
|---|
| 77 | \subsection{Detailed Description} |
|---|
| 78 | DataLink is a connection between two data vectors Up and Down. |
|---|
| 79 | |
|---|
| 80 | Up can be longer than Down. Down must be fully present in Up (TODO optional) See chart: \begin{center} |
|---|
| 81 | \begin{ImageNoCaption}\mbox{\includegraphics{inline_dotgraph_1}} |
|---|
| 82 | \end{ImageNoCaption} |
|---|
| 83 | \end{center} |
|---|
| 84 | |
|---|
| 85 | |
|---|
| 86 | Class for storing results (and semi-results) of an experiment This class abstracts logging of results from implementation. This class replaces direct logging of results (e.g. to files or to global variables) by calling methods of a \hyperlink{classbdm_1_1logger}{logger}. Specializations of this abstract class for specific storage method are designed. |
|---|
| 87 | |
|---|
| 88 | The documentation for this class was generated from the following file:\begin{CompactItemize} |
|---|
| 89 | \item |
|---|
| 90 | \hyperlink{libBM_8h}{libBM.h}\end{CompactItemize} |
|---|
