Changeset 368 for doc/html/classbdm_1_1migamma__ref.html

Timestamp:

06/08/09 18:02:55 (16 years ago)

Author:

smidl

Message:

doc

Files:

• doc/html/classbdm_1_1migamma__ref.html (modified) (4 diffs)

doc/html/classbdm_1_1migamma__ref.html

@@ -91 +91 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update <code>ep</code> so that it represents this <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a> conditioned on <code>rvc</code> = cond. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma__ref.html#6ab1cf56dd7b718c285ee65d8953cf3e">from_setting</a> (const Setting &amp;root)</td></tr>
+
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b10ab922e2a7bae2fb6bb3efc7b6151"></a><!-- doxytag: member="bdm::migamma_ref::set_parameters" ref="8b10ab922e2a7bae2fb6bb3efc7b6151" args="(int len, double k0)" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma.html#8b10ab922e2a7bae2fb6bb3efc7b6151">set_parameters</a> (int len, double k0)</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set value of <code>k</code>. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d95e9de79ca1d52b06f1b8f80660f09"></a><!-- doxytag: member="bdm::migamma_ref::ToString" ref="3d95e9de79ca1d52b06f1b8f80660f09" args="()" -->
-virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#3d95e9de79ca1d52b06f1b8f80660f09">ToString</a> ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::migamma_ref::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" -->
+virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::migamma_ref::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">from_setting</a> (const Setting &amp;root)</td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::migamma_ref::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " -->
 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>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::migamma_ref::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
 <tr><td colspan="2"><div class="groupHeader">Matematical operations</div></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#f0c1db6fcbb3aae2dd6123884457a367">samplecond</a> (const vec &amp;cond)</td></tr>
@@ -198 +200 @@
 ==== Check == vv = Standard deviation of the random walk is proportional to one <img class="formulaInl" alt="$k$" src="form_68.png">-th the mean. This is achieved by setting <img class="formulaInl" alt="$\alpha=k$" src="form_69.png"> and <img class="formulaInl" alt="$\beta=k/\mu$" src="form_70.png">.<p>
 The standard deviation of the walk is then: <img class="formulaInl" alt="$\mu/\sqrt(k)$" src="form_71.png">. <hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="6ab1cf56dd7b718c285ee65d8953cf3e"></a><!-- doxytag: member="bdm::migamma_ref::from_setting" ref="6ab1cf56dd7b718c285ee65d8953cf3e" args="(const Setting &amp;root)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void bdm::migamma_ref::from_setting           </td>
+          <td>(</td>
+          <td class="paramtype">const Setting &amp;&nbsp;</td>
+          <td class="paramname"> <em>root</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+<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 <a class="el" href="classbdm_1_1migamma__ref.html" title="Inverse-Gamma random walk around a fixed point.">migamma_ref</a><p>
+The <a class="el" href="classbdm_1_1migamma__ref.html" title="Inverse-Gamma random walk around a fixed point.">migamma_ref</a> is constructed from a structure with fields: <div class="fragment"><pre class="fragment">                        system = {
+                                type = <span class="stringliteral">"migamma_ref"</span>;
+                                ref = [1e-5; 1e-5; 1e-2 1e-3];            <span class="comment">// reference vector</span>
+                                <a class="code" href="classbdm_1_1migamma__ref.html#cdc1345ba8375fbdb18a69322d2f841d" title="parameter l">l</a> = 0.999;                                <span class="comment">// constant l</span>
+                                <a class="code" href="classbdm_1_1migamma.html#dc56bc9da542e0103ec16b9be8e5e38c" title="Constant .">k</a> = 0.1;                                  <span class="comment">// constant k</span>
+                                
+                                <span class="comment">// == OPTIONAL ==</span>
+                                <span class="comment">// description of y variables</span>
+                                y = {type=<span class="stringliteral">"rv"</span>; names=[<span class="stringliteral">"y"</span>, <span class="stringliteral">"u"</span>];};
+                                <span class="comment">// description of u variable</span>
+                                u = {type=<span class="stringliteral">"rv"</span>; names=[];}
+                        };
+</pre></div><p>
+Result if 
+<p>Reimplemented from <a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">bdm::bdmroot</a>.</p>
+
+<p>References <a class="el" href="user__info_8h-source.html#l00249">bdm::UI::get()</a>, and <a class="el" href="libEF_8h-source.html#l00748">set_parameters()</a>.</p>
+
+</div>
+</div><p>
 <a class="anchor" name="f0c1db6fcbb3aae2dd6123884457a367"></a><!-- doxytag: member="bdm::migamma_ref::samplecond" ref="f0c1db6fcbb3aae2dd6123884457a367" args="(const vec &amp;cond)" -->
 <div class="memitem">
@@ -225 +265 @@
 <p>Reimplemented in <a class="el" href="classbdm_1_1mprod.html#ee715a8013acf9892f6cb489db595555">bdm::mprod</a>.</p>
 
-<p>References <a class="el" href="libBM_8h-source.html#l00353">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00326">bdm::mpdf::ep</a>, and <a class="el" href="libBM_8h-source.html#l00266">bdm::epdf::sample()</a>.</p>
-
-<p>Referenced by <a class="el" href="libPF_8h-source.html#l00207">bdm::MPF&lt; BM_T &gt;::bayes()</a>, <a class="el" href="libPF_8cpp-source.html#l00007">bdm::PF::bayes()</a>, and <a class="el" href="libDS_8cpp-source.html#l00042">bdm::ArxDS::step()</a>.</p>
+<p>References <a class="el" href="libBM_8h-source.html#l00345">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00318">bdm::mpdf::ep</a>, and <a class="el" href="libBM_8h-source.html#l00258">bdm::epdf::sample()</a>.</p>
+
+<p>Referenced by <a class="el" href="libPF_8h-source.html#l00207">bdm::MPF&lt; BM_T &gt;::bayes()</a>, <a class="el" href="libPF_8cpp-source.html#l00007">bdm::PF::bayes()</a>, and <a class="el" href="libDS_8cpp-source.html#l00044">bdm::ArxDS::step()</a>.</p>
 
 </div>
@@ -266 +306 @@
 </dl>
 
-<p>References <a class="el" href="libBM_8h-source.html#l00353">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00310">bdm::epdf::dimension()</a>, <a class="el" href="libBM_8h-source.html#l00326">bdm::mpdf::ep</a>, and <a class="el" href="libBM_8h-source.html#l00266">bdm::epdf::sample()</a>.</p>
+<p>References <a class="el" href="libBM_8h-source.html#l00345">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00302">bdm::epdf::dimension()</a>, <a class="el" href="libBM_8h-source.html#l00318">bdm::mpdf::ep</a>, and <a class="el" href="libBM_8h-source.html#l00258">bdm::epdf::sample()</a>.</p>
 
 </div>
 </div><p>
-<hr>The documentation for this class was generated from the following file:<ul>
-<li><a class="el" href="libEF_8h-source.html">libEF.h</a></ul>
-</div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:11:01 2009 for mixpp by&nbsp;
+<hr>The documentation for this class was generated from the following files:<ul>
+<li><a class="el" href="libEF_8h-source.html">libEF.h</a><li>libEF.cpp</ul>
+</div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 8 18:02:35 2009 for mixpp by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>