root/doc/html/classbdm_1_1mlognorm.html @ 296

Revision 296, 17.4 kB (checked in by smidl, 16 years ago)

doc

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::mlognorm Class 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><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1mlognorm.html">mlognorm</a>
68  </div>
69</div>
70<div class="contents">
71<h1>bdm::mlognorm Class Reference</h1><!-- doxytag: class="bdm::mlognorm" --><!-- doxytag: inherits="bdm::mpdf" -->Log-Normal random walk. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="libEF_8h-source.html">libEF.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classbdm_1_1mlognorm-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5d6eb2688d02e0348b96c4fbd7bde41"></a><!-- doxytag: member="bdm::mlognorm::mlognorm" ref="a5d6eb2688d02e0348b96c4fbd7bde41" args="()" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mlognorm.html#a5d6eb2688d02e0348b96c4fbd7bde41">mlognorm</a> ()</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="604cab0e8a76f9041dc3c606043bb39f"></a><!-- doxytag: member="bdm::mlognorm::set_parameters" ref="604cab0e8a76f9041dc3c606043bb39f" args="(int size, double k)" -->
86void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mlognorm.html#604cab0e8a76f9041dc3c606043bb39f">set_parameters</a> (int size, double k)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set value of <code>k</code>. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9106d8fd8bdf2b6be675ffd8f3ca584e"></a><!-- doxytag: member="bdm::mlognorm::condition" ref="9106d8fd8bdf2b6be675ffd8f3ca584e" args="(const vec &amp;val)" -->
90void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mlognorm.html#9106d8fd8bdf2b6be675ffd8f3ca584e">condition</a> (const vec &amp;val)</td></tr>
91
92<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>
93<tr><td colspan="2"><div class="groupHeader">Matematical operations</div></td></tr>
94<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>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_46.png">.  <a href="#f0c1db6fcbb3aae2dd6123884457a367"></a><br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#afe4185b26baeb03688202e254d3b005">samplecond_m</a> (const vec &amp;cond, int N)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#afe4185b26baeb03688202e254d3b005"></a><br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6336a8a72462e2a56a3989a220f18b1b"></a><!-- doxytag: member="bdm::mlognorm::evallogcond" ref="6336a8a72462e2a56a3989a220f18b1b" args="(const vec &amp;dt, const vec &amp;cond)" -->
101virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#6336a8a72462e2a56a3989a220f18b1b">evallogcond</a> (const vec &amp;dt, const vec &amp;cond)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for conditioning and evaluation of the internal <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>. In some cases, this operation can be implemented efficiently. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b0ed1ed663071bb7cf4a1349eb94fcb"></a><!-- doxytag: member="bdm::mlognorm::evallogcond_m" ref="0b0ed1ed663071bb7cf4a1349eb94fcb" 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.html#0b0ed1ed663071bb7cf4a1349eb94fcb">evallogcond_m</a> (const mat &amp;Dt, const vec &amp;cond)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
108<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::mlognorm::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" -->
110<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> ()</td></tr>
111
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26001264236846897bd11e4baad47245"></a><!-- doxytag: member="bdm::mlognorm::_rvc" ref="26001264236846897bd11e4baad47245" args="()" -->
113<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> ()</td></tr>
114
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c2bae3e1e90874e72941863974ec0ed"></a><!-- doxytag: member="bdm::mlognorm::dimension" ref="1c2bae3e1e90874e72941863974ec0ed" args="()" -->
116int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> ()</td></tr>
117
118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::mlognorm::dimensionc" ref="35e135910aed187b7290742f50e61bc8" args="()" -->
119int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
120
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1892fe3933488942253679f068e9e7f6"></a><!-- doxytag: member="bdm::mlognorm::_epdf" ref="1892fe3933488942253679f068e9e7f6" args="()" -->
122<a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_epdf</b> ()</td></tr>
123
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05e843fd11c410a99dad2b88c55aca80"></a><!-- doxytag: member="bdm::mlognorm::_e" ref="05e843fd11c410a99dad2b88c55aca80" args="()" -->
125<a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>_e</b> ()</td></tr>
126
127<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7631a5570e4ade1420065e8df78f4401"></a><!-- doxytag: member="bdm::mlognorm::set_rvc" ref="7631a5570e4ade1420065e8df78f4401" args="(const RV &amp;rvc0)" -->
129void&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>
130
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18ac26bc2f96ae01ef4eb06178abbd75"></a><!-- doxytag: member="bdm::mlognorm::set_rv" ref="18ac26bc2f96ae01ef4eb06178abbd75" args="(const RV &amp;rv0)" -->
132void&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>
133
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::mlognorm::isnamed" ref="f8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
135bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
136
137<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="56531859a814c60daec38c559455ffca"></a><!-- doxytag: member="bdm::mlognorm::eno" ref="56531859a814c60daec38c559455ffca" args="" -->
139<a class="el" href="classbdm_1_1elognorm.html">elognorm</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>eno</b></td></tr>
140
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a51128a2e503b8b2ce698244b9e0db1a"></a><!-- doxytag: member="bdm::mlognorm::sig2" ref="a51128a2e503b8b2ce698244b9e0db1a" args="" -->
142double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mlognorm.html#a51128a2e503b8b2ce698244b9e0db1a">sig2</a></td></tr>
143
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">parameter 1/2*sigma^2 <br></td></tr>
145<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d0063f77d899ef22e8c5edd642176d2"></a><!-- doxytag: member="bdm::mlognorm::mu" ref="7d0063f77d899ef22e8c5edd642176d2" args="" -->
146vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mlognorm.html#7d0063f77d899ef22e8c5edd642176d2">mu</a></td></tr>
147
148<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access <br></td></tr>
149<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mlognorm::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
150int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
151
152<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br></td></tr>
153<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mlognorm::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
154<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>
155
156<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
157<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5eea43c56d38e4441bfb30270db949c0"></a><!-- doxytag: member="bdm::mlognorm::ep" ref="5eea43c56d38e4441bfb30270db949c0" args="" -->
158<a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#5eea43c56d38e4441bfb30270db949c0">ep</a></td></tr>
159
160<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pointer to internal <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> <br></td></tr>
161</table>
162<hr><a name="_details"></a><h2>Detailed Description</h2>
163Log-Normal random walk.
164<p>
165Mean value, <img class="formulaInl" alt="$\mu$" src="form_62.png">, is...<p>
166==== Check == vv = Standard deviation of the random walk is proportional to one <img class="formulaInl" alt="$k$" src="form_63.png">-th the mean. This is achieved by setting <img class="formulaInl" alt="$\alpha=k$" src="form_64.png"> and <img class="formulaInl" alt="$\beta=k/\mu$" src="form_65.png">.<p>
167The standard deviation of the walk is then: <img class="formulaInl" alt="$\mu/\sqrt(k)$" src="form_66.png">. <hr><h2>Member Function Documentation</h2>
168<a class="anchor" name="f0c1db6fcbb3aae2dd6123884457a367"></a><!-- doxytag: member="bdm::mlognorm::samplecond" ref="f0c1db6fcbb3aae2dd6123884457a367" args="(const vec &amp;cond)" -->
169<div class="memitem">
170<div class="memproto">
171      <table class="memname">
172        <tr>
173          <td class="memname">virtual vec bdm::mpdf::samplecond           </td>
174          <td>(</td>
175          <td class="paramtype">const vec &amp;&nbsp;</td>
176          <td class="paramname"> <em>cond</em>          </td>
177          <td>&nbsp;)&nbsp;</td>
178          <td><code> [inline, virtual, inherited]</code></td>
179        </tr>
180      </table>
181</div>
182<div class="memdoc">
183
184<p>
185Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_46.png">.
186<p>
187<dl compact><dt><b>Parameters:</b></dt><dd>
188  <table border="0" cellspacing="2" cellpadding="0">
189    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
190  </table>
191</dl>
192
193<p>Reimplemented in <a class="el" href="classbdm_1_1mprod.html#ee715a8013acf9892f6cb489db595555">bdm::mprod</a>.</p>
194
195<p>References <a class="el" href="libBM_8h-source.html#l00329">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00302">bdm::mpdf::ep</a>, and <a class="el" href="libBM_8h-source.html#l00242">bdm::epdf::sample()</a>.</p>
196
197<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#l00043">bdm::ArxDS::step()</a>.</p>
198
199</div>
200</div><p>
201<a class="anchor" name="afe4185b26baeb03688202e254d3b005"></a><!-- doxytag: member="bdm::mlognorm::samplecond_m" ref="afe4185b26baeb03688202e254d3b005" args="(const vec &amp;cond, int N)" -->
202<div class="memitem">
203<div class="memproto">
204      <table class="memname">
205        <tr>
206          <td class="memname">virtual mat bdm::mpdf::samplecond_m           </td>
207          <td>(</td>
208          <td class="paramtype">const vec &amp;&nbsp;</td>
209          <td class="paramname"> <em>cond</em>, </td>
210        </tr>
211        <tr>
212          <td class="paramkey"></td>
213          <td></td>
214          <td class="paramtype">int&nbsp;</td>
215          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
216        </tr>
217        <tr>
218          <td></td>
219          <td>)</td>
220          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
221        </tr>
222      </table>
223</div>
224<div class="memdoc">
225
226<p>
227Returns.
228<p>
229<dl compact><dt><b>Parameters:</b></dt><dd>
230  <table border="0" cellspacing="2" cellpadding="0">
231    <tr><td valign="top"></td><td valign="top"><em>N</em>&nbsp;</td><td>samples from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_46.png">. </td></tr>
232    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
233  </table>
234</dl>
235
236<p>References <a class="el" href="libBM_8h-source.html#l00329">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00286">bdm::epdf::dimension()</a>, <a class="el" href="libBM_8h-source.html#l00302">bdm::mpdf::ep</a>, and <a class="el" href="libBM_8h-source.html#l00242">bdm::epdf::sample()</a>.</p>
237
238</div>
239</div><p>
240<hr>The documentation for this class was generated from the following file:<ul>
241<li><a class="el" href="libEF_8h-source.html">libEF.h</a></ul>
242</div>
243<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 17 13:52:06 2009 for mixpp by&nbsp;
244<a href="http://www.doxygen.org/index.html">
245<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
246</body>
247</html>
Note: See TracBrowser for help on using the browser.