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

Revision 616, 19.1 kB (checked in by smidl, 15 years ago)

doc, sorted related pages

Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<title>mixpp: bdm::mgnorm&lt; sq_T &gt; Class Template Reference</title>
6<link href="tabs.css" rel="stylesheet" type="text/css"/>
7<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8</head>
9<body>
10<!-- Generated by Doxygen 1.6.1 -->
11<script type="text/javascript">
12<!--
13function changeDisplayState (e){
14  var num=this.id.replace(/[^[0-9]/g,'');
15  var button=this.firstChild;
16  var sectionDiv=document.getElementById('dynsection'+num);
17  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
18    sectionDiv.style.display='block';
19    button.src='open.gif';
20  }else{
21    sectionDiv.style.display='none';
22    button.src='closed.gif';
23  }
24}
25function initDynSections(){
26  var divs=document.getElementsByTagName('div');
27  var sectionCounter=1;
28  for(var i=0;i<divs.length-1;i++){
29    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
30      var header=divs[i];
31      var section=divs[i+1];
32      var button=header.firstChild;
33      if (button!='IMG'){
34        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
35        button=document.createElement('img');
36        divs[i].insertBefore(button,divs[i].firstChild);
37      }
38      header.style.cursor='pointer';
39      header.onclick=changeDisplayState;
40      header.id='dynheader'+sectionCounter;
41      button.src='closed.gif';
42      section.id='dynsection'+sectionCounter;
43      section.style.display='none';
44      section.style.marginLeft='14px';
45      sectionCounter++;
46    }
47  }
48}
49window.onload = initDynSections;
50-->
51</script>
52<div class="navigation" id="top">
53  <div class="tabs">
54    <ul>
55      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
56      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
57      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
58      <li><a href="files.html"><span>Files</span></a></li>
59    </ul>
60  </div>
61  <div class="tabs">
62    <ul>
63      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
64      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
65      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
66      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
67    </ul>
68  </div>
69  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1mgnorm.html">mgnorm</a>
70  </div>
71</div>
72<div class="contents">
73<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;" -->
74<p>Mpdf with general function for mean value. 
75<a href="#_details">More...</a></p>
76<hr/><a name="_details"></a><h2>Detailed Description</h2>
77<h3>template&lt;class sq_T&gt;<br/>
78 class bdm::mgnorm&lt; sq_T &gt;</h3>
79
80<p>Mpdf with general function for mean value. </p>
81
82<p><code>#include &lt;<a class="el" href="exp__family_8h_source.html">exp_family.h</a>&gt;</code></p>
83
84<p><a href="classbdm_1_1mgnorm-members.html">List of all members.</a></p>
85<table border="0" cellpadding="0" cellspacing="0">
86<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
87<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b014915d74470d3efab74e07cacb97d"></a><!-- doxytag: member="bdm::mgnorm::mgnorm" ref="a1b014915d74470d3efab74e07cacb97d" args="()" -->
88&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgnorm.html#a1b014915d74470d3efab74e07cacb97d">mgnorm</a> ()</td></tr>
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br/></td></tr>
90<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab736332d20e418bf50d45836e129f339"></a><!-- doxytag: member="bdm::mgnorm::set_parameters" ref="ab736332d20e418bf50d45836e129f339" args="(const shared_ptr&lt; fnc &gt; &amp;g0, const sq_T &amp;R0)" -->
91void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgnorm.html#ab736332d20e418bf50d45836e129f339">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>
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set mean function <br/></td></tr>
93<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab31d63472cf6a1030cd8dbd8094c1f6d"></a><!-- doxytag: member="bdm::mgnorm::condition" ref="ab31d63472cf6a1030cd8dbd8094c1f6d" args="(const vec &amp;cond)" -->
94void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mgnorm.html#ab31d63472cf6a1030cd8dbd8094c1f6d">condition</a> (const vec &amp;cond)</td></tr>
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>
96<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>
97<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b4d1cb8d7e230e313b4f0c905874d5a"></a><!-- doxytag: member="bdm::mgnorm::e" ref="a6b4d1cb8d7e230e313b4f0c905874d5a" args="()" -->
98<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>
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function to iepdf <br/></td></tr>
100<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8e547695d1cc19219b91164d825c930"></a><!-- doxytag: member="bdm::mgnorm::samplecond" ref="ad8e547695d1cc19219b91164d825c930" args="(const vec &amp;cond)" -->
101vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf__internal.html#ad8e547695d1cc19219b91164d825c930">samplecond</a> (const vec &amp;cond)</td></tr>
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplements samplecond using <code>condition()</code>. <br/></td></tr>
103<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89076e62b8d7df7616bad68c94591948"></a><!-- doxytag: member="bdm::mgnorm::evallogcond" ref="a89076e62b8d7df7616bad68c94591948" args="(const vec &amp;val, const vec &amp;cond)" -->
104double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf__internal.html#a89076e62b8d7df7616bad68c94591948">evallogcond</a> (const vec &amp;val, const vec &amp;cond)</td></tr>
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reimplements evallogcond using <code>condition()</code>. <br/></td></tr>
106<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae28c214e3063733a6e4d17738941c61c"></a><!-- doxytag: member="bdm::mgnorm::evallogcond_m" ref="ae28c214e3063733a6e4d17738941c61c" args="(const mat &amp;Dt, const vec &amp;cond)" -->
107virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf__internal.html#ae28c214e3063733a6e4d17738941c61c">evallogcond_m</a> (const mat &amp;Dt, const vec &amp;cond)</td></tr>
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Efficient version of evallogcond for matrices. <br/></td></tr>
109<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae82db07ce8af02f29cfd81e014edb3db"></a><!-- doxytag: member="bdm::mgnorm::evallogcond_m" ref="ae82db07ce8af02f29cfd81e014edb3db" args="(const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)" -->
110virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf__internal.html#ae82db07ce8af02f29cfd81e014edb3db">evallogcond_m</a> (const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)</td></tr>
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" align="right" valign="top"><a class="anchor" id="a9554c554054da2d22cb8e908ae9c8823"></a><!-- doxytag: member="bdm::mgnorm::samplecond_m" ref="a9554c554054da2d22cb8e908ae9c8823" 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#a9554c554054da2d22cb8e908ae9c8823">samplecond_m</a> (const vec &amp;cond, int N)</td></tr>
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Efficient version of samplecond. <br/></td></tr>
115<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mgnorm::to_string" ref="aaf0e6941ba5919cae1bc530e2181b109" args="()" -->
116virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#aaf0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br/></td></tr>
118<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::mgnorm::to_setting" ref="a67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
119virtual 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>
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br/></td></tr>
121<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mgnorm::validate" ref="a1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
122virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#a1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br/></td></tr>
124<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
125<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpb6eb094f9e6af11f8a7d9efa9d8e3623"></a> </p>
126<br/><br/></div></td></tr>
127<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa0095f80870f15209bca68a8a7bad8a"></a><!-- doxytag: member="bdm::mgnorm::_rv" ref="aaa0095f80870f15209bca68a8a7bad8a" args="() const " -->
128const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> () const </td></tr>
129<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a739d5202899bb56792a547c74e517a11"></a><!-- doxytag: member="bdm::mgnorm::_rvc" ref="a739d5202899bb56792a547c74e517a11" args="() const " -->
130const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> () const </td></tr>
131<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeea4a999ed9679181335927e9cb66d28"></a><!-- doxytag: member="bdm::mgnorm::dimension" ref="aeea4a999ed9679181335927e9cb66d28" args="() const " -->
132int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> () const </td></tr>
133<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::mgnorm::dimensionc" ref="a35e135910aed187b7290742f50e61bc8" args="()" -->
134int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
135<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
136<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp91e4120baa9617769b7119bfb087c022"></a> </p>
137<br/><br/></div></td></tr>
138<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7631a5570e4ade1420065e8df78f4401"></a><!-- doxytag: member="bdm::mgnorm::set_rvc" ref="a7631a5570e4ade1420065e8df78f4401" args="(const RV &amp;rvc0)" -->
139void&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>
140<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18ac26bc2f96ae01ef4eb06178abbd75"></a><!-- doxytag: member="bdm::mgnorm::set_rv" ref="a18ac26bc2f96ae01ef4eb06178abbd75" args="(const RV &amp;rv0)" -->
141void&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>
142<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::mgnorm::isnamed" ref="af8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
143bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
144<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
145<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a147afacb393324bb3f9a7a89e33f835e"></a><!-- doxytag: member="bdm::mgnorm::set_ep" ref="a147afacb393324bb3f9a7a89e33f835e" args="(epdf &amp;iepdf)" -->
146void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#a147afacb393324bb3f9a7a89e33f835e">set_ep</a> (<a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;<a class="el" href="classbdm_1_1mpdf__internal.html#a47bab632af15120c88aad647ae129468">iepdf</a>)</td></tr>
147<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>
148<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7555b377f8b5895c9b759c9628ee3e20"></a><!-- doxytag: member="bdm::mgnorm::set_ep" ref="a7555b377f8b5895c9b759c9628ee3e20" args="(epdf *iepdfp)" -->
149void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#a7555b377f8b5895c9b759c9628ee3e20">set_ep</a> (<a class="el" href="classbdm_1_1epdf.html">epdf</a> *iepdfp)</td></tr>
150<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>
151<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
152<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47bab632af15120c88aad647ae129468"></a><!-- doxytag: member="bdm::mgnorm::iepdf" ref="a47bab632af15120c88aad647ae129468" args="" -->
153<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#a47bab632af15120c88aad647ae129468">iepdf</a></td></tr>
154<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal epdf used for sampling. <br/></td></tr>
155<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mgnorm::dimc" ref="a7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
156int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#a7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br/></td></tr>
158<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mgnorm::rvc" ref="a5a5f08950daa08b85b01ddf4e1c36288" args="" -->
159<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#a5a5f08950daa08b85b01ddf4e1c36288">rvc</a></td></tr>
160<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br/></td></tr>
161</table>
162<hr/><h2>Member Function Documentation</h2>
163<a class="anchor" id="ad717dacc6a9eb967f8410994dc6dc6f9"></a><!-- doxytag: member="bdm::mgnorm::from_setting" ref="ad717dacc6a9eb967f8410994dc6dc6f9" args="(const Setting &amp;set)" -->
164<div class="memitem">
165<div class="memproto">
166<div class="memtemplate">
167template&lt;class sq_T &gt; </div>
168      <table class="memname">
169        <tr>
170          <td class="memname">void <a class="el" href="classbdm_1_1mgnorm.html">bdm::mgnorm</a>&lt; sq_T &gt;::from_setting </td>
171          <td>(</td>
172          <td class="paramtype">const Setting &amp;&nbsp;</td>
173          <td class="paramname"> <em>set</em></td>
174          <td>&nbsp;)&nbsp;</td>
175          <td><code> [inline, virtual]</code></td>
176        </tr>
177      </table>
178</div>
179<div class="memdoc">
180<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>
181<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>
182<div class="fragment"><pre class="fragment">                system = {
183                        type = <span class="stringliteral">&quot;mgnorm&quot;</span>;
184                        <span class="comment">// function for mean value evolution</span>
185                        g = {type=<span class="stringliteral">&quot;fnc&quot;</span>; ... }
186
187                        <span class="comment">// variance</span>
188                        R = [1, 0,
189                                 0, 1];
190                        <span class="comment">// --OR --</span>
191                        dR = [1, 1];
192
193                        <span class="comment">// == OPTIONAL ==</span>
194
195                        <span class="comment">// description of y variables</span>
196                        y = {type=<span class="stringliteral">&quot;rv&quot;</span>; names=[<span class="stringliteral">&quot;y&quot;</span>, <span class="stringliteral">&quot;u&quot;</span>];};
197                        <span class="comment">// description of u variable</span>
198                        u = {type=<span class="stringliteral">&quot;rv&quot;</span>; names=[];}
199                };
200</pre></div><p>Result if </p>
201
202<p>Reimplemented from <a class="el" href="classbdm_1_1mpdf.html#a30a0bceb948e287d497c578e371b1667">bdm::mpdf</a>.</p>
203
204<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>
205
206</div>
207</div>
208<hr/>The documentation for this class was generated from the following file:<ul>
209<li><a class="el" href="exp__family_8h_source.html">exp_family.h</a></li>
210</ul>
211</div>
212<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 13 23:08:56 2009 for mixpp by&nbsp;
213<a href="http://www.doxygen.org/index.html">
214<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
215</body>
216</html>
Note: See TracBrowser for help on using the browser.