root/library/doc/html/classbdm_1_1mgnorm.html @ 651

Revision 651, 18.6 kB (checked in by mido, 15 years ago)

\doc directory cleaned a bit

RevLine 
[651]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
[287]3<title>mixpp: bdm::mgnorm&lt; sq_T &gt; Class Template Reference</title>
[651]4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.9 -->
[271]8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
[259]49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
[271]52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
[259]53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
[290]54      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
[259]55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
[290]61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
[259]62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
64    </ul>
65  </div>
[287]66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1mgnorm.html">mgnorm</a>
[259]67  </div>
68</div>
69<div class="contents">
[651]70<h1>bdm::mgnorm&lt; sq_T &gt; Class Template Reference</h1><!-- doxytag: class="bdm::mgnorm" --><!-- doxytag: inherits="mpdf_internal&lt; enorm&lt; sq_T &gt; &gt;" -->Mpdf with general function for mean value. 
71<a href="#_details">More...</a>
72<p>
73<code>#include &lt;<a class="el" href="exp__family_8h_source.html">exp_family.h</a>&gt;</code>
74<p>
[287]75
[651]76<p>
77<a href="classbdm_1_1mgnorm-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
78<tr><td></td></tr>
79<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b014915d74470d3efab74e07cacb97d"></a><!-- doxytag: member="bdm::mgnorm::mgnorm" ref="1b014915d74470d3efab74e07cacb97d" args="()" -->
81&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgnorm.html#1b014915d74470d3efab74e07cacb97d">mgnorm</a> ()</td></tr>
[616]82
[651]83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b736332d20e418bf50d45836e129f339"></a><!-- doxytag: member="bdm::mgnorm::set_parameters" ref="b736332d20e418bf50d45836e129f339" args="(const shared_ptr&lt; fnc &gt; &amp;g0, const sq_T &amp;R0)" -->
85void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgnorm.html#b736332d20e418bf50d45836e129f339">set_parameters</a> (const <a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; <a class="el" href="classbdm_1_1fnc.html">fnc</a> &gt; &amp;g0, const sq_T &amp;R0)</td></tr>
[259]86
[651]87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set mean function <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b31d63472cf6a1030cd8dbd8094c1f6d"></a><!-- doxytag: member="bdm::mgnorm::condition" ref="b31d63472cf6a1030cd8dbd8094c1f6d" args="(const vec &amp;cond)" -->
89void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgnorm.html#b31d63472cf6a1030cd8dbd8094c1f6d">condition</a> (const vec &amp;cond)</td></tr>
90
91<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>
92<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgnorm.html#d717dacc6a9eb967f8410994dc6dc6f9">from_setting</a> (const Setting &amp;set)</td></tr>
93
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5cbae3b521d010016af26a3a3124158"></a><!-- doxytag: member="bdm::mgnorm::validate" ref="a5cbae3b521d010016af26a3a3124158" args="()" -->
95void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgnorm.html#a5cbae3b521d010016af26a3a3124158">validate</a> ()</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6b4d1cb8d7e230e313b4f0c905874d5a"></a><!-- doxytag: member="bdm::mgnorm::e" ref="6b4d1cb8d7e230e313b4f0c905874d5a" args="()" -->
99<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#6b4d1cb8d7e230e313b4f0c905874d5a">e</a> ()</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function to iepdf <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8e547695d1cc19219b91164d825c930"></a><!-- doxytag: member="bdm::mgnorm::samplecond" ref="d8e547695d1cc19219b91164d825c930" args="(const vec &amp;cond)" -->
103vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf__internal.html#d8e547695d1cc19219b91164d825c930">samplecond</a> (const vec &amp;cond)</td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplements samplecond using <code>condition()</code>. <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="89076e62b8d7df7616bad68c94591948"></a><!-- doxytag: member="bdm::mgnorm::evallogcond" ref="89076e62b8d7df7616bad68c94591948" args="(const vec &amp;val, const vec &amp;cond)" -->
107double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf__internal.html#89076e62b8d7df7616bad68c94591948">evallogcond</a> (const vec &amp;val, const vec &amp;cond)</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplements evallogcond using <code>condition()</code>. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e28c214e3063733a6e4d17738941c61c"></a><!-- doxytag: member="bdm::mgnorm::evallogcond_m" ref="e28c214e3063733a6e4d17738941c61c" args="(const mat &amp;Dt, const vec &amp;cond)" -->
111virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf__internal.html#e28c214e3063733a6e4d17738941c61c">evallogcond_m</a> (const mat &amp;Dt, const vec &amp;cond)</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Efficient version of evallogcond for matrices. <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e82db07ce8af02f29cfd81e014edb3db"></a><!-- doxytag: member="bdm::mgnorm::evallogcond_m" ref="e82db07ce8af02f29cfd81e014edb3db" args="(const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)" -->
115virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf__internal.html#e82db07ce8af02f29cfd81e014edb3db">evallogcond_m</a> (const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)</td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Efficient version of evallogcond for Array&lt;vec&gt;. <br></td></tr>
118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9554c554054da2d22cb8e908ae9c8823"></a><!-- doxytag: member="bdm::mgnorm::samplecond_m" ref="9554c554054da2d22cb8e908ae9c8823" args="(const vec &amp;cond, int N)" -->
119virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf__internal.html#9554c554054da2d22cb8e908ae9c8823">samplecond_m</a> (const vec &amp;cond, int N)</td></tr>
120
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Efficient version of samplecond. <br></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mgnorm::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
123virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::mgnorm::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
127virtual 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>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
[270]130<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
[651]131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa0095f80870f15209bca68a8a7bad8a"></a><!-- doxytag: member="bdm::mgnorm::_rv" ref="aa0095f80870f15209bca68a8a7bad8a" args="() const " -->
[608]132const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> () const </td></tr>
[651]133
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="739d5202899bb56792a547c74e517a11"></a><!-- doxytag: member="bdm::mgnorm::_rvc" ref="739d5202899bb56792a547c74e517a11" args="() const " -->
[608]135const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> () const </td></tr>
[651]136
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eea4a999ed9679181335927e9cb66d28"></a><!-- doxytag: member="bdm::mgnorm::dimension" ref="eea4a999ed9679181335927e9cb66d28" args="() const " -->
[538]138int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> () const </td></tr>
[651]139
140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::mgnorm::dimensionc" ref="35e135910aed187b7290742f50e61bc8" args="()" -->
[270]141int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
[651]142
[270]143<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
[651]144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7631a5570e4ade1420065e8df78f4401"></a><!-- doxytag: member="bdm::mgnorm::set_rvc" ref="7631a5570e4ade1420065e8df78f4401" args="(const RV &amp;rvc0)" -->
[270]145void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_rvc</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rvc0)</td></tr>
[651]146
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18ac26bc2f96ae01ef4eb06178abbd75"></a><!-- doxytag: member="bdm::mgnorm::set_rv" ref="18ac26bc2f96ae01ef4eb06178abbd75" args="(const RV &amp;rv0)" -->
[270]148void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_rv</b> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv0)</td></tr>
[651]149
150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::mgnorm::isnamed" ref="f8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
[270]151bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
[651]152
153<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
154<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="147afacb393324bb3f9a7a89e33f835e"></a><!-- doxytag: member="bdm::mgnorm::set_ep" ref="147afacb393324bb3f9a7a89e33f835e" args="(epdf &amp;iepdf)" -->
155void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#147afacb393324bb3f9a7a89e33f835e">set_ep</a> (<a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;<a class="el" href="classbdm_1_1mpdf__internal.html#47bab632af15120c88aad647ae129468">iepdf</a>)</td></tr>
156
157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set internal pointer <code>ep</code> to point to given <code>iepdf</code> <br></td></tr>
158<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7555b377f8b5895c9b759c9628ee3e20"></a><!-- doxytag: member="bdm::mgnorm::set_ep" ref="7555b377f8b5895c9b759c9628ee3e20" args="(epdf *iepdfp)" -->
159void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7555b377f8b5895c9b759c9628ee3e20">set_ep</a> (<a class="el" href="classbdm_1_1epdf.html">epdf</a> *iepdfp)</td></tr>
160
161<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set internal pointer <code>ep</code> to point to given <code>iepdf</code> <br></td></tr>
162<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
163<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="47bab632af15120c88aad647ae129468"></a><!-- doxytag: member="bdm::mgnorm::iepdf" ref="47bab632af15120c88aad647ae129468" args="" -->
164<a class="el" href="classbdm_1_1enorm.html">enorm</a>&lt; sq_T &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf__internal.html#47bab632af15120c88aad647ae129468">iepdf</a></td></tr>
165
166<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal epdf used for sampling. <br></td></tr>
167<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mgnorm::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
168int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
169
170<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br></td></tr>
171<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mgnorm::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
172<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#5a5f08950daa08b85b01ddf4e1c36288">rvc</a></td></tr>
173
174<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
[259]175</table>
[651]176<hr><a name="_details"></a><h2>Detailed Description</h2>
177<h3>template&lt;class sq_T&gt;<br>
178 class bdm::mgnorm&lt; sq_T &gt;</h3>
179
180Mpdf with general function for mean value. <hr><h2>Member Function Documentation</h2>
181<a class="anchor" name="d717dacc6a9eb967f8410994dc6dc6f9"></a><!-- doxytag: member="bdm::mgnorm::from_setting" ref="d717dacc6a9eb967f8410994dc6dc6f9" args="(const Setting &amp;set)" -->
[259]182<div class="memitem">
183<div class="memproto">
[538]184<div class="memtemplate">
185template&lt;class sq_T &gt; </div>
[259]186      <table class="memname">
187        <tr>
[651]188          <td class="memname">void <a class="el" href="classbdm_1_1mgnorm.html">bdm::mgnorm</a>&lt; sq_T &gt;::from_setting           </td>
[259]189          <td>(</td>
[538]190          <td class="paramtype">const Setting &amp;&nbsp;</td>
[651]191          <td class="paramname"> <em>set</em>          </td>
[269]192          <td>&nbsp;)&nbsp;</td>
[538]193          <td><code> [inline, virtual]</code></td>
[259]194        </tr>
195      </table>
196</div>
197<div class="memdoc">
[651]198
199<p>
200Create Normal density with given function of mean value <p class="formulaDsp">
201<img class="formulaDsp" alt="\[ f(rv|rvc) = N( g(rvc), R) \]" src="form_169.png">
202<p>
203 from structure <div class="fragment"><pre class="fragment">                <span class="keyword">class </span>= '<a class="code" href="classbdm_1_1mgnorm.html#1b014915d74470d3efab74e07cacb97d" title="default constructor">mgnorm</a>';
204                g.class =  <span class="stringliteral">'fnc'</span>;      <span class="comment">// function for mean value evolution</span>
[621]205                g._fields_of_fnc = ...;
[259]206
[621]207                R = [1, 0;             <span class="comment">// covariance matrix</span>
208                        0, 1];
209                        --OR --
210                dR = [1, 1];           <span class="comment">// diagonal of cavariance matrix</span>
[259]211
[651]212                rv = RV({<span class="stringliteral">'name'</span>})      <span class="comment">// description of RV</span>
213                <a class="code" href="classbdm_1_1mpdf.html#5a5f08950daa08b85b01ddf4e1c36288" title="random variable in condition">rvc</a> = RV({<span class="stringliteral">'name'</span>})     <span class="comment">// description of RV in condition</span>
[621]214</pre></div> 
[651]215<p>Reimplemented from <a class="el" href="classbdm_1_1mpdf.html#30a0bceb948e287d497c578e371b1667">bdm::mpdf</a>.</p>
[259]216
[651]217<p>References <a class="el" href="user__info_8h_source.html#l00451">bdm::UI::get()</a>, <a class="el" href="exp__family_8h_source.html#l01476">bdm::mgnorm&lt; sq_T &gt;::set_parameters()</a>, and <a class="el" href="exp__family_8h_source.html#l00762">bdm::mgnorm&lt; sq_T &gt;::validate()</a>.</p>
[591]218
[259]219</div>
[651]220</div><p>
221<hr>The documentation for this class was generated from the following file:<ul>
222<li><a class="el" href="exp__family_8h_source.html">exp_family.h</a></ul>
[397]223</div>
[651]224<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:48 2009 for mixpp by&nbsp;
[259]225<a href="http://www.doxygen.org/index.html">
[651]226<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
[259]227</body>
228</html>
Note: See TracBrowser for help on using the browser.