root/library/doc/html/classbdm_1_1migamma__ref.html @ 397

Revision 397, 27.8 kB (checked in by smidl, 15 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::migamma_ref 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.9 -->
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_1migamma__ref.html">migamma_ref</a>
68  </div>
69</div>
70<div class="contents">
71<h1>bdm::migamma_ref Class Reference</h1><!-- doxytag: class="bdm::migamma_ref" --><!-- doxytag: inherits="bdm::migamma" -->Inverse-Gamma random walk around a fixed point. 
72<a href="#_details">More...</a>
73<p>
74<<<<<<< HEAD:library/doc/html/classbdm_1_1migamma__ref.html
75<code>#include &lt;<a class="el" href="exp__family_8h_source.html">exp_family.h</a>&gt;</code>
76=======
77<code>#include &lt;<a class="el" href="exp__family_8h-source.html">exp_family.h</a>&gt;</code>
78>>>>>>> doc:library/doc/html/classbdm_1_1migamma__ref.html
79<p>
80
81<p>
82<a href="classbdm_1_1migamma__ref-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
83<tr><td></td></tr>
84<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f45b15a10f084991ba6b48295f10421f"></a><!-- doxytag: member="bdm::migamma_ref::migamma_ref" ref="f45b15a10f084991ba6b48295f10421f" args="()" -->
86&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma__ref.html#f45b15a10f084991ba6b48295f10421f">migamma_ref</a> ()</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0b4eb278ef5d0831ec4954ba7bd2800"></a><!-- doxytag: member="bdm::migamma_ref::set_parameters" ref="b0b4eb278ef5d0831ec4954ba7bd2800" args="(double k0, vec ref0, double l0)" -->
90void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma__ref.html#b0b4eb278ef5d0831ec4954ba7bd2800">set_parameters</a> (double k0, vec ref0, double l0)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set value of <code>k</code>. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae86b2e4ff963d62e05d4e130514634a"></a><!-- doxytag: member="bdm::migamma_ref::condition" ref="ae86b2e4ff963d62e05d4e130514634a" args="(const vec &amp;val)" -->
94void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma__ref.html#ae86b2e4ff963d62e05d4e130514634a">condition</a> (const vec &amp;val)</td></tr>
95
96<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>
97<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma__ref.html#9e7e0f7d2aa9ecca8ec1af8cbcb5ef1d">from_setting</a> (const Setting &amp;set)</td></tr>
98
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b10ab922e2a7bae2fb6bb3efc7b6151"></a><!-- doxytag: member="bdm::migamma_ref::set_parameters" ref="8b10ab922e2a7bae2fb6bb3efc7b6151" args="(int len, double k0)" -->
100void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma.html#8b10ab922e2a7bae2fb6bb3efc7b6151">set_parameters</a> (int len, double k0)</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set value of <code>k</code>. <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::migamma_ref::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
104virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::migamma_ref::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
108virtual 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>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::migamma_ref::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
112virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
115<tr><td colspan="2"><div class="groupHeader">Matematical operations</div></td></tr>
116<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>
117
118<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_11.png">.  <a href="#f0c1db6fcbb3aae2dd6123884457a367"></a><br></td></tr>
119<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>
120
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#afe4185b26baeb03688202e254d3b005"></a><br></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6336a8a72462e2a56a3989a220f18b1b"></a><!-- doxytag: member="bdm::migamma_ref::evallogcond" ref="6336a8a72462e2a56a3989a220f18b1b" args="(const vec &amp;dt, const vec &amp;cond)" -->
123virtual 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>
124
125<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>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b0ed1ed663071bb7cf4a1349eb94fcb"></a><!-- doxytag: member="bdm::migamma_ref::evallogcond_m" ref="0b0ed1ed663071bb7cf4a1349eb94fcb" args="(const mat &amp;Dt, const vec &amp;cond)" -->
127virtual 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>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a0d03756f59924fd038980ee60bd904"></a><!-- doxytag: member="bdm::migamma_ref::evallogcond_m" ref="2a0d03756f59924fd038980ee60bd904" args="(const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)" -->
131virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#2a0d03756f59924fd038980ee60bd904">evallogcond_m</a> (const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)</td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array&lt;vec&gt; version of evallogcond. <br></td></tr>
134<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
135<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::migamma_ref::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" -->
136<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> ()</td></tr>
137
138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26001264236846897bd11e4baad47245"></a><!-- doxytag: member="bdm::migamma_ref::_rvc" ref="26001264236846897bd11e4baad47245" args="()" -->
139<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> ()</td></tr>
140
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c2bae3e1e90874e72941863974ec0ed"></a><!-- doxytag: member="bdm::migamma_ref::dimension" ref="1c2bae3e1e90874e72941863974ec0ed" args="()" -->
142int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> ()</td></tr>
143
144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::migamma_ref::dimensionc" ref="35e135910aed187b7290742f50e61bc8" args="()" -->
145int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
146
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1892fe3933488942253679f068e9e7f6"></a><!-- doxytag: member="bdm::migamma_ref::_epdf" ref="1892fe3933488942253679f068e9e7f6" args="()" -->
148<a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_epdf</b> ()</td></tr>
149
150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05e843fd11c410a99dad2b88c55aca80"></a><!-- doxytag: member="bdm::migamma_ref::_e" ref="05e843fd11c410a99dad2b88c55aca80" args="()" -->
151<a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>_e</b> ()</td></tr>
152
153<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
154<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7631a5570e4ade1420065e8df78f4401"></a><!-- doxytag: member="bdm::migamma_ref::set_rvc" ref="7631a5570e4ade1420065e8df78f4401" args="(const RV &amp;rvc0)" -->
155void&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>
156
157<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18ac26bc2f96ae01ef4eb06178abbd75"></a><!-- doxytag: member="bdm::migamma_ref::set_rv" ref="18ac26bc2f96ae01ef4eb06178abbd75" args="(const RV &amp;rv0)" -->
158void&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>
159
160<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::migamma_ref::isnamed" ref="f8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
161bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
162
163<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
164<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cdc1345ba8375fbdb18a69322d2f841d"></a><!-- doxytag: member="bdm::migamma_ref::l" ref="cdc1345ba8375fbdb18a69322d2f841d" args="" -->
165double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma__ref.html#cdc1345ba8375fbdb18a69322d2f841d">l</a></td></tr>
166
167<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">parameter l <br></td></tr>
168<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3692dc67caf4367e15564d37f45476f6"></a><!-- doxytag: member="bdm::migamma_ref::refl" ref="3692dc67caf4367e15564d37f45476f6" args="" -->
169vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma__ref.html#3692dc67caf4367e15564d37f45476f6">refl</a></td></tr>
170
171<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">reference vector <br></td></tr>
172<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a31b39d4179551b593c9e0d7d756783a"></a><!-- doxytag: member="bdm::migamma_ref::epdf" ref="a31b39d4179551b593c9e0d7d756783a" args="" -->
173<a class="el" href="classbdm_1_1eigamma.html">eigamma</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma.html#a31b39d4179551b593c9e0d7d756783a">epdf</a></td></tr>
174
175<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> that arise by conditioning on <code>rvc</code>. <br></td></tr>
176<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dc56bc9da542e0103ec16b9be8e5e38c"></a><!-- doxytag: member="bdm::migamma_ref::k" ref="dc56bc9da542e0103ec16b9be8e5e38c" args="" -->
177double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma.html#dc56bc9da542e0103ec16b9be8e5e38c">k</a></td></tr>
178
179<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constant <img class="formulaInl" alt="$k$" src="form_76.png">. <br></td></tr>
180<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c9847093da59a9ba0ebb68d2c592f5dc"></a><!-- doxytag: member="bdm::migamma_ref::_alpha" ref="c9847093da59a9ba0ebb68d2c592f5dc" args="" -->
181vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma.html#c9847093da59a9ba0ebb68d2c592f5dc">_alpha</a></td></tr>
182
183<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of epdf.alpha <br></td></tr>
184<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0d854c047001b5465cf1ba21f52904b5"></a><!-- doxytag: member="bdm::migamma_ref::_beta" ref="0d854c047001b5465cf1ba21f52904b5" args="" -->
185vec &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1migamma.html#0d854c047001b5465cf1ba21f52904b5">_beta</a></td></tr>
186
187<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">cache of epdf.beta <br></td></tr>
188<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::migamma_ref::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
189int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
190
191<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br></td></tr>
192<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::migamma_ref::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
193<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>
194
195<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
196<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5eea43c56d38e4441bfb30270db949c0"></a><!-- doxytag: member="bdm::migamma_ref::ep" ref="5eea43c56d38e4441bfb30270db949c0" args="" -->
197<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>
198
199<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>
200</table>
201<hr><a name="_details"></a><h2>Detailed Description</h2>
202Inverse-Gamma random walk around a fixed point.
203<p>
204Mean value, <img class="formulaInl" alt="$\mu$" src="form_75.png">, of this density is given by a geometric combination of <code>rvc</code> and given fixed point, <img class="formulaInl" alt="$p$" src="form_66.png">. <img class="formulaInl" alt="$l$" src="form_85.png"> is the coefficient of the geometric combimation <p class="formulaDsp">
205<img class="formulaDsp" alt="\[ \mu = \mu_{t-1} ^{l} p^{1-l}\]" src="form_86.png">
206<p>
207<p>
208<<<<<<< HEAD:library/doc/html/classbdm_1_1migamma__ref.html
209==== Check == vv = Standard deviation of the random walk is proportional to one <img class="formulaInl" alt="$k$" src="form_68.png">-th the mean. This is achieved by setting <img class="formulaInl" alt="$\alpha=k$" src="form_69.png"> and <img class="formulaInl" alt="$\beta=k/\mu$" src="form_70.png">.<p>
210The standard deviation of the walk is then: <img class="formulaInl" alt="$\mu/\sqrt(k)$" src="form_71.png">. <hr><h2>Member Function Documentation</h2>
211=======
212==== Check == vv = Standard deviation of the random walk is proportional to one <img class="formulaInl" alt="$k$" src="form_76.png">-th the mean. This is achieved by setting <img class="formulaInl" alt="$\alpha=k$" src="form_77.png"> and <img class="formulaInl" alt="$\beta=k/\mu$" src="form_78.png">.<p>
213The standard deviation of the walk is then: <img class="formulaInl" alt="$\mu/\sqrt(k)$" src="form_79.png">. <hr><h2>Member Function Documentation</h2>
214>>>>>>> doc:library/doc/html/classbdm_1_1migamma__ref.html
215<a class="anchor" name="9e7e0f7d2aa9ecca8ec1af8cbcb5ef1d"></a><!-- doxytag: member="bdm::migamma_ref::from_setting" ref="9e7e0f7d2aa9ecca8ec1af8cbcb5ef1d" args="(const Setting &amp;set)" -->
216<div class="memitem">
217<div class="memproto">
218      <table class="memname">
219        <tr>
220          <td class="memname">void bdm::migamma_ref::from_setting           </td>
221          <td>(</td>
222          <td class="paramtype">const Setting &amp;&nbsp;</td>
223          <td class="paramname"> <em>set</em>          </td>
224          <td>&nbsp;)&nbsp;</td>
225          <td><code> [virtual]</code></td>
226        </tr>
227      </table>
228</div>
229<div class="memdoc">
230
231<p>
232<a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a> for <a class="el" href="classbdm_1_1migamma__ref.html" title="Inverse-Gamma random walk around a fixed point.">migamma_ref</a><p>
233The <a class="el" href="classbdm_1_1migamma__ref.html" title="Inverse-Gamma random walk around a fixed point.">migamma_ref</a> is constructed from a structure with fields: <div class="fragment"><pre class="fragment">                        system = {
234                                type = <span class="stringliteral">"migamma_ref"</span>;
235                                ref = [1e-5; 1e-5; 1e-2 1e-3];            <span class="comment">// reference vector</span>
236                                <a class="code" href="classbdm_1_1migamma__ref.html#cdc1345ba8375fbdb18a69322d2f841d" title="parameter l">l</a> = 0.999;                                <span class="comment">// constant l</span>
237                                <a class="code" href="classbdm_1_1migamma.html#dc56bc9da542e0103ec16b9be8e5e38c" title="Constant .">k</a> = 0.1;                                  <span class="comment">// constant k</span>
238                               
239                                <span class="comment">// == OPTIONAL ==</span>
240                                <span class="comment">// description of y variables</span>
241                                y = {type=<span class="stringliteral">"rv"</span>; names=[<span class="stringliteral">"y"</span>, <span class="stringliteral">"u"</span>];};
242                                <span class="comment">// description of u variable</span>
243                                u = {type=<span class="stringliteral">"rv"</span>; names=[];}
244                        };
245</pre></div><p>
246Result if
247<p>Reimplemented from <a class="el" href="classbdm_1_1mpdf.html#30a0bceb948e287d497c578e371b1667">bdm::mpdf</a>.</p>
248
249<<<<<<< HEAD:library/doc/html/classbdm_1_1migamma__ref.html
250<p>References <a class="el" href="user__info_8h_source.html#l00358">bdm::UI::get()</a>, and <a class="el" href="exp__family_8h_source.html#l00820">set_parameters()</a>.</p>
251=======
252<p>References <a class="el" href="exp__family_8h-source.html#l00820">set_parameters()</a>.</p>
253>>>>>>> doc:library/doc/html/classbdm_1_1migamma__ref.html
254
255</div>
256</div><p>
257<a class="anchor" name="f0c1db6fcbb3aae2dd6123884457a367"></a><!-- doxytag: member="bdm::migamma_ref::samplecond" ref="f0c1db6fcbb3aae2dd6123884457a367" args="(const vec &amp;cond)" -->
258<div class="memitem">
259<div class="memproto">
260      <table class="memname">
261        <tr>
262          <td class="memname">virtual vec bdm::mpdf::samplecond           </td>
263          <td>(</td>
264          <td class="paramtype">const vec &amp;&nbsp;</td>
265          <td class="paramname"> <em>cond</em>          </td>
266          <td>&nbsp;)&nbsp;</td>
267          <td><code> [inline, virtual, inherited]</code></td>
268        </tr>
269      </table>
270</div>
271<div class="memdoc">
272
273<p>
274Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_11.png">.
275<p>
276<dl compact><dt><b>Parameters:</b></dt><dd>
277  <table border="0" cellspacing="2" cellpadding="0">
278    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
279  </table>
280</dl>
281
282<p>Reimplemented in <a class="el" href="classbdm_1_1mprod.html#ee715a8013acf9892f6cb489db595555">bdm::mprod</a>.</p>
283
284<<<<<<< HEAD:library/doc/html/classbdm_1_1migamma__ref.html
285<p>References <a class="el" href="bdmbase_8h_source.html#l00376">bdm::mpdf::condition()</a>, <a class="el" href="bdmbase_8h_source.html#l00348">bdm::mpdf::ep</a>, and <a class="el" href="bdmbase_8h_source.html#l00263">bdm::epdf::sample()</a>.</p>
286
287<p>Referenced by <a class="el" href="particles_8h_source.html#l00207">bdm::MPF&lt; BM_T &gt;::bayes()</a>, <a class="el" href="particles_8cpp_source.html#l00007">bdm::PF::bayes()</a>, and <a class="el" href="datasources_8cpp_source.html#l00043">bdm::ArxDS::step()</a>.</p>
288=======
289<p>References <a class="el" href="bdmbase_8h-source.html#l00376">bdm::mpdf::condition()</a>, <a class="el" href="bdmbase_8h-source.html#l00348">bdm::mpdf::ep</a>, and <a class="el" href="bdmbase_8h-source.html#l00263">bdm::epdf::sample()</a>.</p>
290
291<p>Referenced by <a class="el" href="particles_8h-source.html#l00207">bdm::MPF&lt; BM_T &gt;::bayes()</a>, <a class="el" href="particles_8cpp-source.html#l00007">bdm::PF::bayes()</a>, and <a class="el" href="datasources_8cpp-source.html#l00043">bdm::ArxDS::step()</a>.</p>
292>>>>>>> doc:library/doc/html/classbdm_1_1migamma__ref.html
293
294</div>
295</div><p>
296<a class="anchor" name="afe4185b26baeb03688202e254d3b005"></a><!-- doxytag: member="bdm::migamma_ref::samplecond_m" ref="afe4185b26baeb03688202e254d3b005" args="(const vec &amp;cond, int N)" -->
297<div class="memitem">
298<div class="memproto">
299      <table class="memname">
300        <tr>
301          <td class="memname">virtual mat bdm::mpdf::samplecond_m           </td>
302          <td>(</td>
303          <td class="paramtype">const vec &amp;&nbsp;</td>
304          <td class="paramname"> <em>cond</em>, </td>
305        </tr>
306        <tr>
307          <td class="paramkey"></td>
308          <td></td>
309          <td class="paramtype">int&nbsp;</td>
310          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
311        </tr>
312        <tr>
313          <td></td>
314          <td>)</td>
315          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
316        </tr>
317      </table>
318</div>
319<div class="memdoc">
320
321<p>
322Returns.
323<p>
324<dl compact><dt><b>Parameters:</b></dt><dd>
325  <table border="0" cellspacing="2" cellpadding="0">
326    <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_11.png">. </td></tr>
327    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
328  </table>
329</dl>
330
331<<<<<<< HEAD:library/doc/html/classbdm_1_1migamma__ref.html
332<p>References <a class="el" href="bdmbase_8h_source.html#l00376">bdm::mpdf::condition()</a>, <a class="el" href="bdmbase_8h_source.html#l00318">bdm::epdf::dimension()</a>, <a class="el" href="bdmbase_8h_source.html#l00348">bdm::mpdf::ep</a>, and <a class="el" href="bdmbase_8h_source.html#l00263">bdm::epdf::sample()</a>.</p>
333=======
334<p>References <a class="el" href="bdmbase_8h-source.html#l00376">bdm::mpdf::condition()</a>, <a class="el" href="bdmbase_8h-source.html#l00318">bdm::epdf::dimension()</a>, <a class="el" href="bdmbase_8h-source.html#l00348">bdm::mpdf::ep</a>, and <a class="el" href="bdmbase_8h-source.html#l00263">bdm::epdf::sample()</a>.</p>
335>>>>>>> doc:library/doc/html/classbdm_1_1migamma__ref.html
336
337</div>
338</div><p>
339<hr>The documentation for this class was generated from the following files:<ul>
340<<<<<<< HEAD:library/doc/html/classbdm_1_1migamma__ref.html
341<li><a class="el" href="exp__family_8h_source.html">exp_family.h</a><li>exp_family.cpp</ul>
342</div>
343<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 24 13:35:57 2009 for mixpp by&nbsp;
344=======
345<li><a class="el" href="exp__family_8h-source.html">exp_family.h</a><li>exp_family.cpp</ul>
346</div>
347<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 23 19:52:54 2009 for mixpp by&nbsp;
348>>>>>>> doc:library/doc/html/classbdm_1_1migamma__ref.html
349<a href="http://www.doxygen.org/index.html">
350<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
351</body>
352</html>
Note: See TracBrowser for help on using the browser.