root/doc/xml/classmemlog.xml @ 245

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.5.6">
  <compounddef id="classmemlog" kind="class" prot="public">
    <compoundname>memlog</compoundname>
    <basecompoundref refid="classlogger" prot="public" virt="non-virtual">logger</basecompoundref>
    <derivedcompoundref refid="classdirfilelog" prot="public" virt="non-virtual">dirfilelog</derivedcompoundref>
    <includes refid="loggers_8h" local="no">loggers.h</includes>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classmemlog_14195f322897ededdac66c404b848ced3" prot="protected" static="no" mutable="no">
        <type>int</type>
        <definition>int memlog::maxlen</definition>
        <argsstring></argsstring>
        <name>maxlen</name>
        <briefdescription>
<para>Maximum length of vectors stored in memory. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="71" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="71" bodyend="-1"/>
        <referencedby refid="classmemlog_1b081ef5acb4816e6b5fcb56c19cc7e47" compoundref="loggers_8h" startline="81" endline="86">init</referencedby>
        <referencedby refid="classmemlog_1c97961eda9cda9f0e63c703cf21e5804" compoundref="loggers_8h" startline="87" endline="87">step</referencedby>
        <referencedby refid="classdirfilelog_1f5fe9483a041591bfe6f3d6393b02aa7" compoundref="loggers_8cpp" startline="117" endline="126">dirfilelog::step</referencedby>
        <referencedby refid="classdirfilelog_1bd95cdb46af194245f88a7b4bf4c66c7" compoundref="loggers_8cpp" startline="77" endline="115">dirfilelog::write_buffers</referencedby>
      </memberdef>
      <memberdef kind="variable" id="classmemlog_13410b4c002636508c43ddcba8d394520" prot="protected" static="no" mutable="no">
        <type>int</type>
        <definition>int memlog::ind</definition>
        <argsstring></argsstring>
        <name>ind</name>
        <briefdescription>
<para>Currect record to be written. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="73" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="73" bodyend="-1"/>
        <referencedby refid="classdirfilelog_14d671baf6f88444d7fe25a5b8a80834a" compoundref="loggers_8cpp" startline="128" endline="131">dirfilelog::finalize</referencedby>
        <referencedby refid="classmemlog_18d2feeb826f7249e9104d616b5a67144" compoundref="loggers_8h" startline="88" endline="90">logit</referencedby>
        <referencedby refid="classmemlog_1c97961eda9cda9f0e63c703cf21e5804" compoundref="loggers_8h" startline="87" endline="87">step</referencedby>
        <referencedby refid="classdirfilelog_1f5fe9483a041591bfe6f3d6393b02aa7" compoundref="loggers_8cpp" startline="117" endline="126">dirfilelog::step</referencedby>
      </memberdef>
      <memberdef kind="variable" id="classmemlog_1f0f5bc7b83539ad102e8f65297852d91" prot="protected" static="no" mutable="no">
        <type>Array&lt; mat &gt;</type>
        <definition>Array&lt;mat&gt; memlog::vectors</definition>
        <argsstring></argsstring>
        <name>vectors</name>
        <briefdescription>
<para>Storage. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="75" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="75" bodyend="-1"/>
        <referencedby refid="classmemlog_1b081ef5acb4816e6b5fcb56c19cc7e47" compoundref="loggers_8h" startline="81" endline="86">init</referencedby>
        <referencedby refid="classmemlog_165571ebbb16577b5211adbb27baf769c" compoundref="loggers_8cpp" startline="10" endline="23">itsave</referencedby>
        <referencedby refid="classmemlog_18d2feeb826f7249e9104d616b5a67144" compoundref="loggers_8h" startline="88" endline="90">logit</referencedby>
        <referencedby refid="classdirfilelog_1bd95cdb46af194245f88a7b4bf4c66c7" compoundref="loggers_8cpp" startline="77" endline="115">dirfilelog::write_buffers</referencedby>
      </memberdef>
      <memberdef kind="variable" id="classlogger_183eea0cf4fbca59474d015f751f128a7" prot="protected" static="no" mutable="no">
        <type>Array&lt; <ref refid="classRV" kindref="compound">RV</ref> &gt;</type>
        <definition>Array&lt;RV&gt; logger::entries</definition>
        <argsstring></argsstring>
        <name>entries</name>
        <briefdescription>
<para>RVs of all logged variables. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="31" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="31" bodyend="-1"/>
        <referencedby refid="classlogger_1cfb250a559b71e07a1a6aa92f2185c1b" compoundref="loggers_8h" startline="39" endline="45">logger::add</referencedby>
        <referencedby refid="classmemlog_1b081ef5acb4816e6b5fcb56c19cc7e47" compoundref="loggers_8h" startline="81" endline="86">init</referencedby>
        <referencedby refid="classdirfilelog_1afeaebe003110f9db1ac43edf8e53a92" compoundref="loggers_8cpp" startline="25" endline="74">dirfilelog::init</referencedby>
        <referencedby refid="classmemlog_165571ebbb16577b5211adbb27baf769c" compoundref="loggers_8cpp" startline="10" endline="23">itsave</referencedby>
        <referencedby refid="classdirfilelog_1bd95cdb46af194245f88a7b4bf4c66c7" compoundref="loggers_8cpp" startline="77" endline="115">dirfilelog::write_buffers</referencedby>
      </memberdef>
      <memberdef kind="variable" id="classlogger_139cb79e839ca8f8bb9dcbc8c5b9c7786" prot="protected" static="no" mutable="no">
        <type>Array&lt; string &gt;</type>
        <definition>Array&lt;string&gt; logger::names</definition>
        <argsstring></argsstring>
        <name>names</name>
        <briefdescription>
<para>Names of logged quantities, e.g. names of algorithm variants. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="33" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="33" bodyend="-1"/>
        <referencedby refid="classlogger_1cfb250a559b71e07a1a6aa92f2185c1b" compoundref="loggers_8h" startline="39" endline="45">logger::add</referencedby>
        <referencedby refid="classdirfilelog_1afeaebe003110f9db1ac43edf8e53a92" compoundref="loggers_8cpp" startline="25" endline="74">dirfilelog::init</referencedby>
        <referencedby refid="classmemlog_165571ebbb16577b5211adbb27baf769c" compoundref="loggers_8cpp" startline="10" endline="23">itsave</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classmemlog_1e056e819c5a65d4431bfe7955b1efe97" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>memlog::memlog</definition>
        <argsstring>(int maxlen0)</argsstring>
        <name>memlog</name>
        <param>
          <type>int</type>
          <declname>maxlen0</declname>
        </param>
        <briefdescription>
<para>Default constructor. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="79" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="79" bodyend="79"/>
      </memberdef>
      <memberdef kind="function" id="classmemlog_1b081ef5acb4816e6b5fcb56c19cc7e47" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void memlog::init</definition>
        <argsstring>()</argsstring>
        <name>init</name>
        <reimplementedby refid="classdirfilelog_1afeaebe003110f9db1ac43edf8e53a92">init</reimplementedby>
        <briefdescription>
<para>Initialize storage. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="81" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="81" bodyend="86"/>
        <references refid="classlogger_183eea0cf4fbca59474d015f751f128a7" compoundref="loggers_8h" startline="31">logger::entries</references>
        <references refid="classmemlog_14195f322897ededdac66c404b848ced3" compoundref="loggers_8h" startline="71">maxlen</references>
        <references refid="classmemlog_1f0f5bc7b83539ad102e8f65297852d91" compoundref="loggers_8h" startline="75">vectors</references>
        <referencedby refid="classdirfilelog_1afeaebe003110f9db1ac43edf8e53a92" compoundref="loggers_8cpp" startline="25" endline="74">dirfilelog::init</referencedby>
      </memberdef>
      <memberdef kind="function" id="classmemlog_1c97961eda9cda9f0e63c703cf21e5804" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>void</type>
        <definition>void memlog::step</definition>
        <argsstring>()</argsstring>
        <name>step</name>
        <reimplements refid="classlogger_1709b3ebefa0da3ed371aa802b06512a2">step</reimplements>
        <reimplementedby refid="classdirfilelog_1f5fe9483a041591bfe6f3d6393b02aa7">step</reimplementedby>
        <briefdescription>
<para>Shifts storage position for another time step. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="87" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="87" bodyend="87"/>
        <references refid="classmemlog_13410b4c002636508c43ddcba8d394520" compoundref="loggers_8h" startline="73">ind</references>
        <references refid="classmemlog_14195f322897ededdac66c404b848ced3" compoundref="loggers_8h" startline="71">maxlen</references>
      </memberdef>
      <memberdef kind="function" id="classmemlog_18d2feeb826f7249e9104d616b5a67144" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>void</type>
        <definition>void memlog::logit</definition>
        <argsstring>(int id, vec v)</argsstring>
        <name>logit</name>
        <reimplements refid="classlogger_1efb5a59cb329f58810b09bd9cc270b78">logit</reimplements>
        <param>
          <type>int</type>
          <declname>id</declname>
        </param>
        <param>
          <type>vec</type>
          <declname>v</declname>
        </param>
        <briefdescription>
<para>log this vector </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="88" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="88" bodyend="90"/>
        <references refid="classmemlog_13410b4c002636508c43ddcba8d394520" compoundref="loggers_8h" startline="73">ind</references>
        <references refid="classmemlog_1f0f5bc7b83539ad102e8f65297852d91" compoundref="loggers_8h" startline="75">vectors</references>
        <referencedby refid="sim__var_8cpp_1e66f6b31b5ad750f1fe042a706a4e3d4" compoundref="sim__var_8cpp" startline="28" endline="166">main</referencedby>
      </memberdef>
      <memberdef kind="function" id="classmemlog_165571ebbb16577b5211adbb27baf769c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void memlog::itsave</definition>
        <argsstring>(const char *fname)</argsstring>
        <name>itsave</name>
        <param>
          <type>const char *</type>
          <declname>fname</declname>
        </param>
        <briefdescription>
<para>Save values into an itfile named after <computeroutput>fname</computeroutput>. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="92" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.cpp" bodystart="10" bodyend="23"/>
        <references refid="classlogger_183eea0cf4fbca59474d015f751f128a7" compoundref="loggers_8h" startline="31">logger::entries</references>
        <references refid="classlogger_139cb79e839ca8f8bb9dcbc8c5b9c7786" compoundref="loggers_8h" startline="33">logger::names</references>
        <references refid="classmemlog_1f0f5bc7b83539ad102e8f65297852d91" compoundref="loggers_8h" startline="75">vectors</references>
      </memberdef>
      <memberdef kind="function" id="classlogger_1cfb250a559b71e07a1a6aa92f2185c1b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>int</type>
        <definition>virtual int logger::add</definition>
        <argsstring>(const RV &amp;rv, string name=&quot;&quot;)</argsstring>
        <name>add</name>
        <param>
          <type>const <ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
          <declname>rv</declname>
        </param>
        <param>
          <type>string</type>
          <declname>name</declname>
          <defval>&quot;&quot;</defval>
        </param>
        <briefdescription>
<para>returns an identifier which will be later needed for calling the log() function </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="39" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="39" bodyend="45"/>
        <references refid="classlogger_183eea0cf4fbca59474d015f751f128a7" compoundref="loggers_8h" startline="31">logger::entries</references>
        <references refid="classlogger_139cb79e839ca8f8bb9dcbc8c5b9c7786" compoundref="loggers_8h" startline="33">logger::names</references>
        <referencedby refid="sim__var_8cpp_1e66f6b31b5ad750f1fe042a706a4e3d4" compoundref="sim__var_8cpp" startline="28" endline="166">main</referencedby>
      </memberdef>
      <memberdef kind="function" id="classlogger_151c1aa8a84a14097b51607a187ae3617" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>void</type>
        <definition>virtual void logger::finalize</definition>
        <argsstring>()</argsstring>
        <name>finalize</name>
        <reimplementedby refid="classdirfilelog_14d671baf6f88444d7fe25a5b8a80834a">finalize</reimplementedby>
        <briefdescription>
<para>Finalize storing information. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="54" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="54" bodyend="54"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Logging into matrices in data format in memory. </para>    </briefdescription>
    <detaileddescription>
<para>More?... </para>    </detaileddescription>
    <inheritancegraph>
      <node id="1179">
        <label>memlog</label>
        <link refid="classmemlog"/>
        <childnode refid="1180" relation="public-inheritance">
        </childnode>
      </node>
      <node id="1181">
        <label>dirfilelog</label>
        <link refid="classdirfilelog"/>
        <childnode refid="1179" relation="public-inheritance">
        </childnode>
      </node>
      <node id="1180">
        <label>logger</label>
        <link refid="classlogger"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="1182">
        <label>memlog</label>
        <link refid="classmemlog"/>
        <childnode refid="1183" relation="public-inheritance">
        </childnode>
      </node>
      <node id="1183">
        <label>logger</label>
        <link refid="classlogger"/>
      </node>
    </collaborationgraph>
    <location file="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" line="67" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/loggers.h" bodystart="67" bodyend="93"/>
    <listofallmembers>
      <member refid="classlogger_1cfb250a559b71e07a1a6aa92f2185c1b" prot="public" virt="virtual"><scope>memlog</scope><name>add</name></member>
      <member refid="classlogger_183eea0cf4fbca59474d015f751f128a7" prot="protected" virt="non-virtual"><scope>memlog</scope><name>entries</name></member>
      <member refid="classlogger_151c1aa8a84a14097b51607a187ae3617" prot="public" virt="virtual"><scope>memlog</scope><name>finalize</name></member>
      <member refid="classmemlog_13410b4c002636508c43ddcba8d394520" prot="protected" virt="non-virtual"><scope>memlog</scope><name>ind</name></member>
      <member refid="classmemlog_1b081ef5acb4816e6b5fcb56c19cc7e47" prot="public" virt="non-virtual"><scope>memlog</scope><name>init</name></member>
      <member refid="classmemlog_165571ebbb16577b5211adbb27baf769c" prot="public" virt="non-virtual"><scope>memlog</scope><name>itsave</name></member>
      <member refid="classlogger_14f753a510e00c892b38e95c2284363a6" prot="public" virt="non-virtual"><scope>memlog</scope><name>logger</name></member>
      <member refid="classmemlog_18d2feeb826f7249e9104d616b5a67144" prot="public" virt="virtual"><scope>memlog</scope><name>logit</name></member>
      <member refid="classmemlog_14195f322897ededdac66c404b848ced3" prot="protected" virt="non-virtual"><scope>memlog</scope><name>maxlen</name></member>
      <member refid="classmemlog_1e056e819c5a65d4431bfe7955b1efe97" prot="public" virt="non-virtual"><scope>memlog</scope><name>memlog</name></member>
      <member refid="classlogger_139cb79e839ca8f8bb9dcbc8c5b9c7786" prot="protected" virt="non-virtual"><scope>memlog</scope><name>names</name></member>
      <member refid="classmemlog_1c97961eda9cda9f0e63c703cf21e5804" prot="public" virt="virtual"><scope>memlog</scope><name>step</name></member>
      <member refid="classmemlog_1f0f5bc7b83539ad102e8f65297852d91" prot="protected" virt="non-virtual"><scope>memlog</scope><name>vectors</name></member>
      <member refid="classlogger_192c63a0a87392c62b9ed3c00faa9d5df" prot="public" virt="virtual"><scope>memlog</scope><name>~logger</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>