Changeset 621 for library/doc/html/classbdm_1_1mgnorm.html

Timestamp:

09/16/09 22:52:42 (15 years ago)

Author:

smidl

Message:

doc - new pattern for from_setting for pdfs

Files:

• library/doc/html/classbdm_1_1mgnorm.html (modified) (4 diffs)

library/doc/html/classbdm_1_1mgnorm.html

@@ -95 +95 @@
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update <code>iepdf</code> so that it represents this <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling , where  is random variable, rv, and...">mpdf</a> conditioned on <code>rvc</code> = cond This function provides convenient reimplementation in offsprings. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgnorm.html#ad717dacc6a9eb967f8410994dc6dc6f9">from_setting</a> (const Setting &amp;set)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5cbae3b521d010016af26a3a3124158"></a><!-- doxytag: member="bdm::mgnorm::validate" ref="aa5cbae3b521d010016af26a3a3124158" args="()" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgnorm.html#aa5cbae3b521d010016af26a3a3124158">validate</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b4d1cb8d7e230e313b4f0c905874d5a"></a><!-- doxytag: member="bdm::mgnorm::e" ref="a6b4d1cb8d7e230e313b4f0c905874d5a" args="()" -->
 <a class="el" href="classbdm_1_1enorm.html">enorm</a>&lt; sq_T &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf__internal.html#a6b4d1cb8d7e230e313b4f0c905874d5a">e</a> ()</td></tr>
@@ -119 +122 @@
 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) 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" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mgnorm::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
-virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">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">Access to attributes</div></td></tr>
 <tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpb6eb094f9e6af11f8a7d9efa9d8e3623"></a> </p>
@@ -178 +178 @@
 </div>
 <div class="memdoc">
-<p><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 <a class="el" href="classbdm_1_1mgnorm.html" title="Mpdf with general function for mean value.">mgnorm</a></p>
-<p>The <a class="el" href="classbdm_1_1mgnorm.html" title="Mpdf with general function for mean value.">mgnorm</a> is constructed from a structure with fields: </p>
-<div class="fragment"><pre class="fragment">                system = {
-                        type = <span class="stringliteral">&quot;mgnorm&quot;</span>;
-                        <span class="comment">// function for mean value evolution</span>
-                        g = {type=<span class="stringliteral">&quot;fnc&quot;</span>; ... }
-
-                        <span class="comment">// variance</span>
-                        R = [1, 0,
-                                 0, 1];
-                        <span class="comment">// --OR --</span>
-                        dR = [1, 1];
-
-                        <span class="comment">// == OPTIONAL ==</span>
-
-                        <span class="comment">// description of y variables</span>
-                        y = {type=<span class="stringliteral">&quot;rv&quot;</span>; names=[<span class="stringliteral">&quot;y&quot;</span>, <span class="stringliteral">&quot;u&quot;</span>];};
-                        <span class="comment">// description of u variable</span>
-                        u = {type=<span class="stringliteral">&quot;rv&quot;</span>; names=[];}
-                };
-</pre></div><p>Result if </p>
-
+<p>Create Normal density with given function of mean value </p>
+<p class="formulaDsp">
+<img class="formulaDsp" alt="\[ f(rv|rvc) = N( g(rvc), R) \]" src="form_169.png"/>
+</p>
+<p> from structure </p>
+<div class="fragment"><pre class="fragment">                <span class="keyword">class </span>= &apos;<a class="code" href="classbdm_1_1mgnorm.html#a1b014915d74470d3efab74e07cacb97d" title="default constructor">mgnorm</a>&apos;;
+                g.class =  <span class="stringliteral">&apos;fnc&apos;</span>;      <span class="comment">// function for mean value evolution</span>
+                g._fields_of_fnc = ...;
+
+                R = [1, 0;             <span class="comment">// covariance matrix</span>
+                        0, 1];
+                        --OR --
+                dR = [1, 1];           <span class="comment">// diagonal of cavariance matrix</span>
+
+                rv = RV({<span class="stringliteral">&apos;name&apos;</span>})      <span class="comment">// description of RV</span>
+                <a class="code" href="classbdm_1_1mpdf.html#a5a5f08950daa08b85b01ddf4e1c36288" title="random variable in condition">rvc</a> = RV({<span class="stringliteral">&apos;name&apos;</span>})     <span class="comment">// description of RV in condition</span>
+</pre></div> 
 <p>Reimplemented from <a class="el" href="classbdm_1_1mpdf.html#a30a0bceb948e287d497c578e371b1667">bdm::mpdf</a>.</p>
 
-<p>References <a class="el" href="user__info_8h_source.html#l00443">bdm::UI::get()</a>, and <a class="el" href="exp__family_8h_source.html#l01380">bdm::mgnorm&lt; sq_T &gt;::set_parameters()</a>.</p>
+<p>References <a class="el" href="user__info_8h_source.html#l00443">bdm::UI::get()</a>, <a class="el" href="exp__family_8h_source.html#l01399">bdm::mgnorm&lt; sq_T &gt;::set_parameters()</a>, and <a class="el" href="exp__family_8h_source.html#l00691">bdm::mgnorm&lt; sq_T &gt;::validate()</a>.</p>
 
 </div>
@@ -210 +205 @@
 </ul>
 </div>
-<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Sep 15 23:42:49 2009 for mixpp by&nbsp;
+<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 16 22:33:34 2009 for mixpp by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>