Show
Ignore:
Timestamp:
08/05/09 00:16:53 (15 years ago)
Author:
mido
Message:

obnovena dokumentace, vcetne pridani mnoha novych doc-souboru do svn

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1RV.html

    r401 r472  
    55<link href="doxygen.css" rel="stylesheet" type="text/css"> 
    66</head><body> 
    7 <!-- Generated by Doxygen 1.5.8 --> 
     7<!-- Generated by Doxygen 1.5.9 --> 
    88<script type="text/javascript"> 
    99<!-- 
    … …  
    5252      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 
    5353      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li> 
    54       <li><a href="modules.html"><span>Modules</span></a></li> 
    5554      <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 
    5655      <li><a href="files.html"><span>Files</span></a></li> 
    … …  
    7271<a href="#_details">More...</a> 
    7372<p> 
    74 <code>#include &lt;<a class="el" href="bdmbase_8h-source.html">bdmbase.h</a>&gt;</code> 
     73<code>#include &lt;<a class="el" href="bdmbase_8h_source.html">bdmbase.h</a>&gt;</code> 
    7574<p> 
    7675 
    … …  
    8180<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#6564bdd36b6845a51446a192d33e1194">from_setting</a> (const Setting &amp;set)</td></tr> 
    8281 
    83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a> for class <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> (description of data vectors).  <a href="#6564bdd36b6845a51446a192d33e1194"></a><br></td></tr> 
     82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for class <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> (description of data vectors).  <a href="#6564bdd36b6845a51446a192d33e1194"></a><br></td></tr> 
    8483<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::RV::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
    8584virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    … …  
    9594<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    9695<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr> 
    97 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d93da01a64dab31074b25b7d93e5eae"></a><!-- doxytag: member="bdm::RV::RV" ref="3d93da01a64dab31074b25b7d93e5eae" args="(Array&lt; std::string &gt; in_names, ivec in_sizes, ivec in_times)" --> 
    98 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#3d93da01a64dab31074b25b7d93e5eae">RV</a> (Array&lt; std::string &gt; in_names, ivec in_sizes, ivec in_times)</td></tr> 
     96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fa35c2744e687c74f7742990e6aa264"></a><!-- doxytag: member="bdm::RV::RV" ref="3fa35c2744e687c74f7742990e6aa264" args="(const Array&lt; std::string &gt; &amp;in_names, const ivec &amp;in_sizes, const ivec &amp;in_times)" --> 
     97&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#3fa35c2744e687c74f7742990e6aa264">RV</a> (const Array&lt; std::string &gt; &amp;in_names, const ivec &amp;in_sizes, const ivec &amp;in_times)</td></tr> 
    9998 
    10099<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Full constructor. <br></td></tr> 
    101 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5bd1bd9ec51b91578ecc83a6b2398a20"></a><!-- doxytag: member="bdm::RV::RV" ref="5bd1bd9ec51b91578ecc83a6b2398a20" args="(Array&lt; std::string &gt; in_names, ivec in_sizes)" --> 
    102 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#5bd1bd9ec51b91578ecc83a6b2398a20">RV</a> (Array&lt; std::string &gt; in_names, ivec in_sizes)</td></tr> 
     100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="381f5d963bb54efd4e76815dc93d50ce"></a><!-- doxytag: member="bdm::RV::RV" ref="381f5d963bb54efd4e76815dc93d50ce" args="(const Array&lt; std::string &gt; &amp;in_names, const ivec &amp;in_sizes)" --> 
     101&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#381f5d963bb54efd4e76815dc93d50ce">RV</a> (const Array&lt; std::string &gt; &amp;in_names, const ivec &amp;in_sizes)</td></tr> 
    103102 
    104103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with times=0. <br></td></tr> 
    105 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a222dfef569e8f123180d40fde97c1cd"></a><!-- doxytag: member="bdm::RV::RV" ref="a222dfef569e8f123180d40fde97c1cd" args="(Array&lt; std::string &gt; in_names)" --> 
    106 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#a222dfef569e8f123180d40fde97c1cd">RV</a> (Array&lt; std::string &gt; in_names)</td></tr> 
     104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb47d71d82639ec7ddf2635b21aafd00"></a><!-- doxytag: member="bdm::RV::RV" ref="cb47d71d82639ec7ddf2635b21aafd00" args="(const Array&lt; std::string &gt; &amp;in_names)" --> 
     105&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#cb47d71d82639ec7ddf2635b21aafd00">RV</a> (const Array&lt; std::string &gt; &amp;in_names)</td></tr> 
    107106 
    108107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with sizes=1, times=0. <br></td></tr> 
    … …  
    133132<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#c0c04ab99ded62e1e05bcefb151ebeb9">subselect</a> (const ivec &amp;ind) const </td></tr> 
    134133 
    135 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indeces ind. <br></td></tr> 
     134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indices ind. <br></td></tr> 
    136135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6f3daf0f857fff53a1c0a445fe160966"></a><!-- doxytag: member="bdm::RV::operator()" ref="6f3daf0f857fff53a1c0a445fe160966" args="(const ivec &amp;ind) const " --> 
    137136<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#6f3daf0f857fff53a1c0a445fe160966">operator()</a> (const ivec &amp;ind) const </td></tr> 
    138137 
    139 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indeces ind. <br></td></tr> 
     138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indices ind. <br></td></tr> 
    140139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="452fb5f7ab1eafe17932bf9f458d0415"></a><!-- doxytag: member="bdm::RV::operator()" ref="452fb5f7ab1eafe17932bf9f458d0415" args="(int di1, int di2) const " --> 
    141140<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#452fb5f7ab1eafe17932bf9f458d0415">operator()</a> (int di1, int di2) const </td></tr> 
    … …  
    145144void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#bd77cb0899f7fba1d0e34396137b7f1f">t</a> (int delta)</td></tr> 
    146145 
    147 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shift <code>time</code> shifted by delta. <br></td></tr> 
     146<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shift <code>time</code> by delta. <br></td></tr> 
    148147<tr><td colspan="2"><div class="groupHeader">Relation to vectors</div></td></tr> 
    149148<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8bdd7f4072749c7cc864b78a418ca388"></a><!-- doxytag: member="bdm::RV::tostr" ref="8bdd7f4072749c7cc864b78a418ca388" args="() const " --> 
    150149<a class="el" href="classbdm_1_1str.html">str</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#8bdd7f4072749c7cc864b78a418ca388">tostr</a> () const </td></tr> 
    151150 
    152 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">generate <code><a class="el" href="classbdm_1_1str.html" title="Structure of RV (used internally), i.e. expanded RVs - TODO tak proc je ve verejnem...">str</a></code> from rv, by expanding sizes TODO to_string.. <br></td></tr> 
     151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">generate <code><a class="el" href="classbdm_1_1str.html" title="Structure of RV, i.e. RVs expanded into a flat list of IDs, used for debugging.">str</a></code> from rv, by expanding sizes TODO to_string.. <br></td></tr> 
    153152<tr><td class="memItemLeft" nowrap align="right" valign="top">ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#cbebdb5e0d30101a6eb63550ef701c55">dataind</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;crv) const </td></tr> 
    154153 
    … …  
    159158 
    160159<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum time-offset. <br></td></tr> 
     160<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> 
     161<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab92b361335a644df654cf7cf7e5ffc0"></a><!-- doxytag: member="bdm::RV::clear_all" ref="ab92b361335a644df654cf7cf7e5ffc0" args="()" --> 
     162static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#ab92b361335a644df654cf7cf7e5ffc0">clear_all</a> ()</td></tr> 
     163 
     164<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Invalidate all named RVs. Use before initializing any <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> instances, with care... <br></td></tr> 
    161165<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 
    162166<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0cfe477965243a89eb87a06b024e2fcb"></a><!-- doxytag: member="bdm::RV::dsize" ref="0cfe477965243a89eb87a06b024e2fcb" args="" --> 
    … …  
    208212std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1RV.html#cad6f15535d10437f6690cb4492176a8">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv)</td></tr> 
    209213 
    210 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Printing output e.g. for debugging. <br></td></tr> 
     214<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">State output, e.g. for debugging. <br></td></tr> 
    211215</table> 
    212216<hr><a name="_details"></a><h2>Detailed Description</h2> 
    … …  
    241245<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if all rv2 were added, false if rv2 is in conflict </dd></dl> 
    242246 
    243 <p>References <a class="el" href="bdmbase_8cpp-source.html#l00045">countsize()</a>, <a class="el" href="bdmbase_8h-source.html#l00090">dsize</a>, <a class="el" href="bdmbase_8cpp-source.html#l00200">findself()</a>, <a class="el" href="bdmbase_8h-source.html#l00094">ids</a>, <a class="el" href="bdmbase_8h-source.html#l00092">len</a>, and <a class="el" href="bdmbase_8h-source.html#l00096">times</a>.</p> 
    244  
    245 <p>Referenced by <a class="el" href="bdmbase_8cpp-source.html#l00254">bdm::compositepdf::getrv()</a>, <a class="el" href="datasources_8h-source.html#l00168">bdm::ArxDS::set_drv()</a>, <a class="el" href="merger_8h-source.html#l00086">bdm::merger_base::set_sources()</a>, and <a class="el" href="bdmbase_8cpp-source.html#l00265">bdm::compositepdf::setrvc()</a>.</p> 
     247<p>References <a class="el" href="bdmbase_8cpp_source.html#l00051">countsize()</a>, <a class="el" href="bdmbase_8h_source.html#l00090">dsize</a>, <a class="el" href="bdmbase_8cpp_source.html#l00266">findself()</a>, <a class="el" href="bdmbase_8h_source.html#l00094">ids</a>, <a class="el" href="bdmbase_8h_source.html#l00092">len</a>, and <a class="el" href="bdmbase_8h_source.html#l00096">times</a>.</p> 
     248 
     249<p>Referenced by <a class="el" href="bdmbase_8cpp_source.html#l00312">bdm::compositepdf::getrv()</a>, <a class="el" href="datasources_8h_source.html#l00168">bdm::ArxDS::set_drv()</a>, <a class="el" href="merger_8h_source.html#l00088">bdm::merger_base::set_sources()</a>, and <a class="el" href="bdmbase_8cpp_source.html#l00323">bdm::compositepdf::setrvc()</a>.</p> 
    246250 
    247251</div> 
    … …  
    279283 
    280284<p> 
    281 generate mutual indeces when copying data betwenn self and crv. Data are copied via: data_of_this(selfi) = data_of_rv2(rv2i)  
    282 <p>References <a class="el" href="bdmbase_8cpp-source.html#l00200">findself()</a>, <a class="el" href="bdmbase_8h-source.html#l00094">ids</a>, <a class="el" href="bdmbase_8h-source.html#l00039">bdm::str::ids</a>, <a class="el" href="bdmbase_8h-source.html#l00127">length()</a>, <a class="el" href="bdmbase_8h-source.html#l00096">times</a>, <a class="el" href="bdmbase_8h-source.html#l00041">bdm::str::times</a>, and <a class="el" href="bdmbase_8cpp-source.html#l00133">tostr()</a>.</p> 
     285generate mutual indices when copying data between self and crv. Data are copied via: data_of_this(selfi) = data_of_rv2(rv2i)  
     286<p>References <a class="el" href="bdmbase_8cpp_source.html#l00266">findself()</a>, <a class="el" href="bdmbase_8h_source.html#l00094">ids</a>, <a class="el" href="bdmbase_8h_source.html#l00039">bdm::str::ids</a>, <a class="el" href="bdmbase_8h_source.html#l00096">times</a>, <a class="el" href="bdmbase_8h_source.html#l00041">bdm::str::times</a>, and <a class="el" href="bdmbase_8cpp_source.html#l00199">tostr()</a>.</p> 
    283287 
    284288</div> 
    … …  
    301305 
    302306<p> 
    303 when this rv is a part of bigger rv, this function returns indeces of self in the data vector of the bigger crv. Then, data can be copied via: data_of_this = cdata(ind);  
    304 <p>References <a class="el" href="bdmbase_8h-source.html#l00123">_dsize()</a>, <a class="el" href="bdmbase_8h-source.html#l00090">dsize</a>, <a class="el" href="bdmbase_8h-source.html#l00094">ids</a>, <a class="el" href="bdmbase_8h-source.html#l00039">bdm::str::ids</a>, <a class="el" href="bdmbase_8h-source.html#l00096">times</a>, <a class="el" href="bdmbase_8h-source.html#l00041">bdm::str::times</a>, and <a class="el" href="bdmbase_8cpp-source.html#l00133">tostr()</a>.</p> 
    305  
    306 <p>Referenced by <a class="el" href="exp__family_8h-source.html#l01298">bdm::enorm&lt; sq_T &gt;::condition()</a>, <a class="el" href="exp__family_8h-source.html#l01284">bdm::enorm&lt; sq_T &gt;::marginal()</a>, <a class="el" href="bdmbase_8h-source.html#l00512">bdm::datalink_m2e::set_connection()</a>, and <a class="el" href="bdmbase_8h-source.html#l00470">bdm::datalink::set_connection()</a>.</p> 
     307when this rv is a part of bigger rv, this function returns indices of self in the data vector of the bigger crv. Then, data can be copied via: data_of_this = cdata(ind);  
     308<p>References <a class="el" href="bdmbase_8h_source.html#l00090">dsize</a>, <a class="el" href="bdmbase_8h_source.html#l00094">ids</a>, <a class="el" href="bdmbase_8h_source.html#l00039">bdm::str::ids</a>, <a class="el" href="bdmbase_8h_source.html#l00096">times</a>, <a class="el" href="bdmbase_8h_source.html#l00041">bdm::str::times</a>, and <a class="el" href="bdmbase_8cpp_source.html#l00199">tostr()</a>.</p> 
     309 
     310<p>Referenced by <a class="el" href="exp__family_8h_source.html#l01319">bdm::enorm&lt; sq_T &gt;::condition()</a>, <a class="el" href="exp__family_8h_source.html#l01305">bdm::enorm&lt; sq_T &gt;::marginal()</a>, and <a class="el" href="bdmbase_8h_source.html#l00461">bdm::datalink::set_connection()</a>.</p> 
    307311 
    308312</div> 
    … …  
    329333<dl class="return" compact><dt><b>Returns:</b></dt><dd>ivec of the same size as self. </dd></dl> 
    330334 
    331 <p>References <a class="el" href="bdmbase_8h-source.html#l00094">ids</a>, <a class="el" href="bdmbase_8h-source.html#l00127">length()</a>, and <a class="el" href="bdmbase_8h-source.html#l00096">times</a>.</p> 
    332  
    333 <p>Referenced by <a class="el" href="bdmbase_8cpp-source.html#l00078">add()</a>, <a class="el" href="bdmbase_8cpp-source.html#l00162">dataind()</a>, and <a class="el" href="bdmbase_8cpp-source.html#l00193">subt()</a>.</p> 
     335<p>References <a class="el" href="bdmbase_8h_source.html#l00094">ids</a>, and <a class="el" href="bdmbase_8h_source.html#l00096">times</a>.</p> 
     336 
     337<p>Referenced by <a class="el" href="bdmbase_8cpp_source.html#l00085">add()</a>, <a class="el" href="bdmbase_8cpp_source.html#l00228">dataind()</a>, and <a class="el" href="bdmbase_8cpp_source.html#l00259">subt()</a>.</p> 
    334338 
    335339</div> 
    … …  
    352356 
    353357<p> 
    354 <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a> for class <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> (description of data vectors).  
     358<a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for class <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> (description of data vectors).  
    355359<p> 
    356360<div class="fragment"><pre class="fragment">  rv = { 
    … …  
    366370<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">bdm::root</a>.</p> 
    367371 
    368 <p>References <a class="el" href="user__info_8h-source.html#l00359">bdm::UI::get()</a>.</p> 
     372<p>References <a class="el" href="user__info_8h_source.html#l00387">bdm::UI::get()</a>.</p> 
    369373 
    370374</div> 
    371375</div><p> 
    372376<hr>The documentation for this class was generated from the following files:<ul> 
    373 <li><a class="el" href="bdmbase_8h-source.html">bdmbase.h</a><li>bdmbase.cpp</ul> 
    374 </div> 
    375 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 1 13:05:57 2009 for mixpp by&nbsp; 
     377<li><a class="el" href="bdmbase_8h_source.html">bdmbase.h</a><li>bdmbase.cpp</ul> 
     378</div> 
     379<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 5 00:06:54 2009 for mixpp by&nbsp; 
    376380<a href="http://www.doxygen.org/index.html"> 
    377 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     381<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    378382</body> 
    379383</html>