Show
Ignore:
Timestamp:
06/24/09 13:38:47 (16 years ago)
Author:
mido
Message:

UI documentation almost finished; UIException redesigned and used instead of UI::ui_error function

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1RV.html

    r385 r396  
    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<!-- 
    … …  
    6969</div> 
    7070<div class="contents"> 
    71 <h1>bdm::RV Class Reference</h1><!-- doxytag: class="bdm::RV" --><!-- doxytag: inherits="bdm::bdmroot" -->Class representing variables, most often random variables.   
     71<h1>bdm::RV Class Reference</h1><!-- doxytag: class="bdm::RV" --><!-- doxytag: inherits="bdm::root" -->Class representing variables, most often random variables.   
    7272<a href="#_details">More...</a> 
    7373<p> 
    74 <code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code> 
     74<code>#include &lt;<a class="el" href="bdmbase_8h_source.html">bdmbase.h</a>&gt;</code> 
    7575<p> 
    7676 
    … …  
    7979<tr><td></td></tr> 
    8080<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    81 <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#d82e3a60503f8d586a05444e5ac4da95">from_setting</a> (const Setting &amp;root)</td></tr> 
    82  
    83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classbdm_1_1UI.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">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="#d82e3a60503f8d586a05444e5ac4da95"></a><br></td></tr> 
    84 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::RV::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" --> 
    85 virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr> 
     81<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> 
     82 
     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> 
     84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::RV::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> 
     85virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> 
    8686 
    8787<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> 
    88 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::RV::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " --> 
    89 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#dd74cb898b22b95b7ee528e040a07618">to_setting</a> (Setting &amp;root) const </td></tr> 
     88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::RV::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " --> 
     89virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr> 
    9090 
    9191<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> 
    92 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::RV::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" --> 
    93 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr> 
     92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::RV::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> 
     93virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> 
    9494 
    9595<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr> 
    … …  
    216216The class is implemented using global variables to assure uniqueness of description:<p> 
    217217In is a vector <div align="center"> 
    218 <img src="inline_dotgraph_2.dot.png" alt="inline_dotgraph_2.dot" border="0" usemap="#inline_dotgraph_2.dot.map"> 
    219 <map name="inline_dotgraph_2.dot.map"></map> 
     218<img src="inline_dotgraph_1.dot.png" alt="inline_dotgraph_1.dot" border="0" usemap="#inline_dotgraph_1.dot.map"> 
     219<map name="inline_dotgraph_1.dot.map"></map> 
    220220</div> 
    221221 <hr><h2>Member Function Documentation</h2> 
    … …  
    241241<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if all rv2 were added, false if rv2 is in conflict </dd></dl> 
    242242 
    243 <p>References <a class="el" href="libBM_8cpp-source.html#l00045">countsize()</a>, <a class="el" href="libBM_8h-source.html#l00087">dsize</a>, <a class="el" href="libBM_8cpp-source.html#l00200">findself()</a>, <a class="el" href="libBM_8h-source.html#l00091">ids</a>, <a class="el" href="libBM_8h-source.html#l00089">len</a>, and <a class="el" href="libBM_8h-source.html#l00093">times</a>.</p> 
    244  
    245 <p>Referenced by <a class="el" href="libBM_8cpp-source.html#l00256">bdm::compositepdf::getrv()</a>, <a class="el" href="libDS_8h-source.html#l00168">bdm::ArxDS::set_drv()</a>, <a class="el" href="merger_8h-source.html#l00079">bdm::merger_base::set_sources()</a>, and <a class="el" href="libBM_8cpp-source.html#l00267">bdm::compositepdf::setrvc()</a>.</p> 
     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#l00081">bdm::merger_base::set_sources()</a>, and <a class="el" href="bdmbase_8cpp_source.html#l00265">bdm::compositepdf::setrvc()</a>.</p> 
    246246 
    247247</div> 
    … …  
    280280<p> 
    281281generate 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="libBM_8cpp-source.html#l00200">findself()</a>, <a class="el" href="libBM_8h-source.html#l00091">ids</a>, <a class="el" href="libBM_8h-source.html#l00037">bdm::str::ids</a>, <a class="el" href="libBM_8h-source.html#l00124">length()</a>, <a class="el" href="libBM_8h-source.html#l00093">times</a>, <a class="el" href="libBM_8h-source.html#l00039">bdm::str::times</a>, and <a class="el" href="libBM_8cpp-source.html#l00133">tostr()</a>.</p> 
     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#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> 
    283283 
    284284</div> 
    … …  
    302302<p> 
    303303when 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="libBM_8h-source.html#l00120">_dsize()</a>, <a class="el" href="libBM_8h-source.html#l00087">dsize</a>, <a class="el" href="libBM_8h-source.html#l00091">ids</a>, <a class="el" href="libBM_8h-source.html#l00037">bdm::str::ids</a>, <a class="el" href="libBM_8h-source.html#l00093">times</a>, <a class="el" href="libBM_8h-source.html#l00039">bdm::str::times</a>, and <a class="el" href="libBM_8cpp-source.html#l00133">tostr()</a>.</p> 
    305  
    306 <p>Referenced by <a class="el" href="libEF_8h-source.html#l01229">bdm::enorm&lt; sq_T &gt;::condition()</a>, <a class="el" href="libEF_8h-source.html#l01215">bdm::enorm&lt; sq_T &gt;::marginal()</a>, <a class="el" href="libBM_8h-source.html#l00453">bdm::datalink_m2e::set_connection()</a>, and <a class="el" href="libBM_8h-source.html#l00412">bdm::datalink::set_connection()</a>.</p> 
     304<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#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> 
    307307 
    308308</div> 
    … …  
    329329<dl class="return" compact><dt><b>Returns:</b></dt><dd>ivec of the same size as self. </dd></dl> 
    330330 
    331 <p>References <a class="el" href="libBM_8h-source.html#l00091">ids</a>, <a class="el" href="libBM_8h-source.html#l00124">length()</a>, and <a class="el" href="libBM_8h-source.html#l00093">times</a>.</p> 
    332  
    333 <p>Referenced by <a class="el" href="libBM_8cpp-source.html#l00078">add()</a>, <a class="el" href="libBM_8cpp-source.html#l00162">dataind()</a>, and <a class="el" href="libBM_8cpp-source.html#l00193">subt()</a>.</p> 
    334  
    335 </div> 
    336 </div><p> 
    337 <a class="anchor" name="d82e3a60503f8d586a05444e5ac4da95"></a><!-- doxytag: member="bdm::RV::from_setting" ref="d82e3a60503f8d586a05444e5ac4da95" args="(const Setting &amp;root)" --> 
     331<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> 
     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> 
     334 
     335</div> 
     336</div><p> 
     337<a class="anchor" name="6564bdd36b6845a51446a192d33e1194"></a><!-- doxytag: member="bdm::RV::from_setting" ref="6564bdd36b6845a51446a192d33e1194" args="(const Setting &amp;set)" --> 
    338338<div class="memitem"> 
    339339<div class="memproto"> 
    … …  
    343343          <td>(</td> 
    344344          <td class="paramtype">const Setting &amp;&nbsp;</td> 
    345           <td class="paramname"> <em>root</em>          </td> 
     345          <td class="paramname"> <em>set</em>          </td> 
    346346          <td>&nbsp;)&nbsp;</td> 
    347347          <td><code> [virtual]</code></td> 
    … …  
    352352 
    353353<p> 
    354 <a class="el" href="classbdm_1_1UI.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">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).  
    355 <p> 
    356 <div class="fragment"><pre class="fragment">        rv = { 
    357                 type = <span class="stringliteral">"rv"</span>; <span class="comment">//identifier of the description</span> 
    358                 <span class="comment">// UNIQUE IDENTIFIER same names = same variable</span> 
    359                 names = [<span class="stringliteral">"a"</span>, <span class="stringliteral">"b"</span>, <span class="stringliteral">"c"</span>, ...];   <span class="comment">// which will be used e.g. in loggers </span> 
    360  
    361                 <span class="comment">//optional arguments</span> 
    362                 sizes = [1, 2, 3, ...];         <span class="comment">// (optional) default = ones()</span> 
    363                 <a class="code" href="classbdm_1_1RV.html#ef6703854820bbf61736738f1bac6896" title="Vector of shifts from current time.">times</a> = [-1, -2, 0, ...];       <span class="comment">// time shifts with respect to current time (optional) default = zeros()</span> 
    364         } 
     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).  
     355<p> 
     356<div class="fragment"><pre class="fragment">  rv = { 
     357    type = <span class="stringliteral">"rv"</span>; <span class="comment">//identifier of the description</span> 
     358    <span class="comment">// UNIQUE IDENTIFIER same names = same variable</span> 
     359    names = [<span class="stringliteral">"a"</span>, <span class="stringliteral">"b"</span>, <span class="stringliteral">"c"</span>, ...];   <span class="comment">// which will be used e.g. in loggers</span> 
     360 
     361    <span class="comment">//optional arguments</span> 
     362    sizes = [1, 2, 3, ...];         <span class="comment">// (optional) default = ones()</span> 
     363    <a class="code" href="classbdm_1_1RV.html#ef6703854820bbf61736738f1bac6896" title="Vector of shifts from current time.">times</a> = [-1, -2, 0, ...];       <span class="comment">// time shifts with respect to current time (optional) default = zeros()</span> 
     364  } 
    365365</pre></div>  
    366 <p>Reimplemented from <a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">bdm::bdmroot</a>.</p> 
    367  
    368 <p>References <a class="el" href="user__info_8h-source.html#l00248">bdm::UI::get()</a>.</p> 
     366<p>Reimplemented from <a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">bdm::root</a>.</p> 
     367 
     368<p>References <a class="el" href="user__info_8h_source.html#l00358">bdm::UI::get()</a>.</p> 
    369369 
    370370</div> 
    371371</div><p> 
    372372<hr>The documentation for this class was generated from the following files:<ul> 
    373 <li><a class="el" href="libBM_8h-source.html">libBM.h</a><li>libBM.cpp</ul> 
    374 </div> 
    375 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 17 14:13:29 2009 for mixpp by&nbsp; 
     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 Jun 24 13:35:48 2009 for mixpp by&nbsp; 
    376376<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> 
     377<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    378378</body> 
    379379</html>