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

Revision 538, 19.6 kB (checked in by smidl, 15 years ago)

Documentation regenerated

Line 
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">
3<title>mixpp: bdm::mgnorm&lt; sq_T &gt; Class Template Reference</title>
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.8 -->
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>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
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>
61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
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>
66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1mgnorm.html">mgnorm</a>
67  </div>
68</div>
69<div class="contents">
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>
75
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>
82
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>
86
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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgnorm.html#b31d63472cf6a1030cd8dbd8094c1f6d">condition</a> (const vec &amp;cond)</td></tr>
89
90<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>
91
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6b4d1cb8d7e230e313b4f0c905874d5a"></a><!-- doxytag: member="bdm::mgnorm::e" ref="6b4d1cb8d7e230e313b4f0c905874d5a" args="()" -->
93<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>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function to iepdf <br></td></tr>
96<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)" -->
97vec&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>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplements samplecond using <code>condition()</code>. <br></td></tr>
100<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)" -->
101double&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>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplements evallogcond using <code>condition()</code>. <br></td></tr>
104<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)" -->
105virtual 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>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Efficient version of evallogcond for matrices. <br></td></tr>
108<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)" -->
109virtual 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>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Efficient version of evallogcond for Array&lt;vec&gt;. <br></td></tr>
112<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)" -->
113virtual 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>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Efficient version of samplecond. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mgnorm::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
117virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
120<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 " -->
121virtual 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>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mgnorm::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
125virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
128<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="222d5280e309c5a053ba73841e98c151"></a><!-- doxytag: member="bdm::mgnorm::_rv" ref="222d5280e309c5a053ba73841e98c151" args="() const " -->
130<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> () const </td></tr>
131
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26001264236846897bd11e4baad47245"></a><!-- doxytag: member="bdm::mgnorm::_rvc" ref="26001264236846897bd11e4baad47245" args="()" -->
133<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> ()</td></tr>
134
135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eea4a999ed9679181335927e9cb66d28"></a><!-- doxytag: member="bdm::mgnorm::dimension" ref="eea4a999ed9679181335927e9cb66d28" args="() const " -->
136int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> () const </td></tr>
137
138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::mgnorm::dimensionc" ref="35e135910aed187b7290742f50e61bc8" args="()" -->
139int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
140
141<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
142<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)" -->
143void&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>
144
145<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)" -->
146void&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>
147
148<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::mgnorm::isnamed" ref="f8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
149bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
150
151<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
152<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)" -->
153void&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>
154
155<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>
156<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)" -->
157void&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>
158
159<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>
160<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
161<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="47bab632af15120c88aad647ae129468"></a><!-- doxytag: member="bdm::mgnorm::iepdf" ref="47bab632af15120c88aad647ae129468" args="" -->
162<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>
163
164<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal epdf used for sampling. <br></td></tr>
165<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mgnorm::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
166int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
167
168<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br></td></tr>
169<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mgnorm::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
170<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>
171
172<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
173</table>
174<hr><a name="_details"></a><h2>Detailed Description</h2>
175<h3>template&lt;class sq_T&gt;<br>
176 class bdm::mgnorm&lt; sq_T &gt;</h3>
177
178Mpdf with general function for mean value. <hr><h2>Member Function Documentation</h2>
179<a class="anchor" name="b31d63472cf6a1030cd8dbd8094c1f6d"></a><!-- doxytag: member="bdm::mgnorm::condition" ref="b31d63472cf6a1030cd8dbd8094c1f6d" args="(const vec &amp;cond)" -->
180<div class="memitem">
181<div class="memproto">
182<div class="memtemplate">
183template&lt;class sq_T &gt; </div>
184      <table class="memname">
185        <tr>
186          <td class="memname">void <a class="el" href="classbdm_1_1mgnorm.html">bdm::mgnorm</a>&lt; sq_T &gt;::condition           </td>
187          <td>(</td>
188          <td class="paramtype">const vec &amp;&nbsp;</td>
189          <td class="paramname"> <em>cond</em>          </td>
190          <td>&nbsp;)&nbsp;</td>
191          <td><code> [inline, virtual]</code></td>
192        </tr>
193      </table>
194</div>
195<div class="memdoc">
196
197<p>
198Update <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
199<p>Reimplemented from <a class="el" href="classbdm_1_1mpdf__internal.html#1ac61da081667fc54bcd050cc4f6a93e">bdm::mpdf_internal&lt; enorm&lt; sq_T &gt; &gt;</a>.</p>
200
201<p>References <a class="el" href="bdmbase_8h-source.html#l00495">bdm::mpdf_internal&lt; enorm&lt; sq_T &gt; &gt;::iepdf</a>.</p>
202
203</div>
204</div><p>
205<a class="anchor" name="d717dacc6a9eb967f8410994dc6dc6f9"></a><!-- doxytag: member="bdm::mgnorm::from_setting" ref="d717dacc6a9eb967f8410994dc6dc6f9" args="(const Setting &amp;set)" -->
206<div class="memitem">
207<div class="memproto">
208<div class="memtemplate">
209template&lt;class sq_T &gt; </div>
210      <table class="memname">
211        <tr>
212          <td class="memname">void <a class="el" href="classbdm_1_1mgnorm.html">bdm::mgnorm</a>&lt; sq_T &gt;::from_setting           </td>
213          <td>(</td>
214          <td class="paramtype">const Setting &amp;&nbsp;</td>
215          <td class="paramname"> <em>set</em>          </td>
216          <td>&nbsp;)&nbsp;</td>
217          <td><code> [inline, virtual]</code></td>
218        </tr>
219      </table>
220</div>
221<div class="memdoc">
222
223<p>
224<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>
225The <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: <div class="fragment"><pre class="fragment">                system = {
226                        type = <span class="stringliteral">"mgnorm"</span>;
227                        <span class="comment">// function for mean value evolution</span>
228                        g = {type=<span class="stringliteral">"fnc"</span>; ... }
229
230                        <span class="comment">// variance</span>
231                        R = [1, 0,
232                                 0, 1];
233                        <span class="comment">// --OR --</span>
234                        dR = [1, 1];
235
236                        <span class="comment">// == OPTIONAL ==</span>
237
238                        <span class="comment">// description of y variables</span>
239                        y = {type=<span class="stringliteral">"rv"</span>; names=[<span class="stringliteral">"y"</span>, <span class="stringliteral">"u"</span>];};
240                        <span class="comment">// description of u variable</span>
241                        u = {type=<span class="stringliteral">"rv"</span>; names=[];}
242                };
243</pre></div><p>
244Result if
245<p>Reimplemented from <a class="el" href="classbdm_1_1mpdf.html#30a0bceb948e287d497c578e371b1667">bdm::mpdf</a>.</p>
246
247<p>References <a class="el" href="user__info_8h-source.html#l00410">bdm::UI::get()</a>, and <a class="el" href="exp__family_8h-source.html#l01337">bdm::mgnorm&lt; sq_T &gt;::set_parameters()</a>.</p>
248
249</div>
250</div><p>
251<hr>The documentation for this class was generated from the following file:<ul>
252<li><a class="el" href="exp__family_8h-source.html">exp_family.h</a></ul>
253</div>
254<hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 16 17:58:19 2009 for mixpp by&nbsp;
255<a href="http://www.doxygen.org/index.html">
256<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
257</body>
258</html>
Note: See TracBrowser for help on using the browser.