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

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

\doc directory cleaned a bit

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::mepdf 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 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_1mepdf.html">mepdf</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::mepdf Class Reference</h1><!-- doxytag: class="bdm::mepdf" --><!-- doxytag: inherits="bdm::mpdf" -->Unconditional <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling , where  is random variable, rv, and...">mpdf</a>, allows using <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> in the role of <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling , where  is random variable, rv, and...">mpdf</a>. 
71<a href="#_details">More...</a>
72<p>
73<code>#include &lt;<a class="el" href="bdmbase_8h_source.html">bdmbase.h</a>&gt;</code>
74<p>
75
76<p>
77<a href="classbdm_1_1mepdf-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="4a2b01e7bb510c6b8946757cae6c9155"></a><!-- doxytag: member="bdm::mepdf::mepdf" ref="4a2b01e7bb510c6b8946757cae6c9155" args="()" -->
81&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mepdf.html#4a2b01e7bb510c6b8946757cae6c9155">mepdf</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="1f94e70702ff676f53d95ca7ec38e25c"></a><!-- doxytag: member="bdm::mepdf::mepdf" ref="1f94e70702ff676f53d95ca7ec38e25c" args="(shared_ptr&lt; epdf &gt; em)" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mepdf.html#1f94e70702ff676f53d95ca7ec38e25c">mepdf</a> (<a class="el" href="classbdm_1_1shared__ptr.html">shared_ptr</a>&lt; <a class="el" href="classbdm_1_1epdf.html">epdf</a> &gt; em)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set internal shared pointer. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b904a90ef78294040b498717cc13015e"></a><!-- doxytag: member="bdm::mepdf::samplecond" ref="b904a90ef78294040b498717cc13015e" args="(const vec &amp;cond)" -->
89vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mepdf.html#b904a90ef78294040b498717cc13015e">samplecond</a> (const vec &amp;cond)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">empty <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="57decd7718f3789e9d1f10f19def935b"></a><!-- doxytag: member="bdm::mepdf::evallogcond" ref="57decd7718f3789e9d1f10f19def935b" args="(const vec &amp;val, const vec &amp;cond)" -->
93double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mepdf.html#57decd7718f3789e9d1f10f19def935b">evallogcond</a> (const vec &amp;val, const vec &amp;cond)</td></tr>
94
95<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>
96<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mepdf.html#27ef18a3e3b1b5de02739d1324bf25fb">from_setting</a> (const Setting &amp;set)</td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load from structure with elements:.  <a href="#27ef18a3e3b1b5de02739d1324bf25fb"></a><br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mepdf::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
100virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::mepdf::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
104virtual 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>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mepdf::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
108virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
111<tr><td colspan="2"><div class="groupHeader">Matematical operations</div></td></tr>
112<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#6e497d501331057309d2fddf63259d1a">samplecond_m</a> (const vec &amp;cond, int N)</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#6e497d501331057309d2fddf63259d1a"></a><br></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b0ed1ed663071bb7cf4a1349eb94fcb"></a><!-- doxytag: member="bdm::mepdf::evallogcond_m" ref="0b0ed1ed663071bb7cf4a1349eb94fcb" args="(const mat &amp;Dt, const vec &amp;cond)" -->
116virtual 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>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a0d03756f59924fd038980ee60bd904"></a><!-- doxytag: member="bdm::mepdf::evallogcond_m" ref="2a0d03756f59924fd038980ee60bd904" args="(const Array&lt; vec &gt; &amp;Dt, const vec &amp;cond)" -->
120virtual 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>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array&lt;vec&gt; version of evallogcond. <br></td></tr>
123<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa0095f80870f15209bca68a8a7bad8a"></a><!-- doxytag: member="bdm::mepdf::_rv" ref="aa0095f80870f15209bca68a8a7bad8a" args="() const " -->
125const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> () const </td></tr>
126
127<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="739d5202899bb56792a547c74e517a11"></a><!-- doxytag: member="bdm::mepdf::_rvc" ref="739d5202899bb56792a547c74e517a11" args="() const " -->
128const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> () const </td></tr>
129
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eea4a999ed9679181335927e9cb66d28"></a><!-- doxytag: member="bdm::mepdf::dimension" ref="eea4a999ed9679181335927e9cb66d28" args="() const " -->
131int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> () const </td></tr>
132
133<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::mepdf::dimensionc" ref="35e135910aed187b7290742f50e61bc8" args="()" -->
134int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
135
136<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7631a5570e4ade1420065e8df78f4401"></a><!-- doxytag: member="bdm::mepdf::set_rvc" ref="7631a5570e4ade1420065e8df78f4401" args="(const RV &amp;rvc0)" -->
138void&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>
139
140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18ac26bc2f96ae01ef4eb06178abbd75"></a><!-- doxytag: member="bdm::mepdf::set_rv" ref="18ac26bc2f96ae01ef4eb06178abbd75" 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
143<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::mepdf::isnamed" ref="f8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
144bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
145
146<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="147afacb393324bb3f9a7a89e33f835e"></a><!-- doxytag: member="bdm::mepdf::set_ep" ref="147afacb393324bb3f9a7a89e33f835e" args="(epdf &amp;iepdf)" -->
148void&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;iepdf)</td></tr>
149
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 class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7555b377f8b5895c9b759c9628ee3e20"></a><!-- doxytag: member="bdm::mepdf::set_ep" ref="7555b377f8b5895c9b759c9628ee3e20" args="(epdf *iepdfp)" -->
152void&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>
153
154<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>
155<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
156<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mepdf::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
157int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
158
159<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br></td></tr>
160<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mepdf::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
161<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>
162
163<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
164</table>
165<hr><a name="_details"></a><h2>Detailed Description</h2>
166Unconditional <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling , where  is random variable, rv, and...">mpdf</a>, allows using <a class="el" href="classbdm_1_1epdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> in the role of <a class="el" href="classbdm_1_1mpdf.html" title="Conditional probability density, e.g. modeling , where  is random variable, rv, and...">mpdf</a>.
167<p>
168<hr><h2>Member Function Documentation</h2>
169<a class="anchor" name="27ef18a3e3b1b5de02739d1324bf25fb"></a><!-- doxytag: member="bdm::mepdf::from_setting" ref="27ef18a3e3b1b5de02739d1324bf25fb" args="(const Setting &amp;set)" -->
170<div class="memitem">
171<div class="memproto">
172      <table class="memname">
173        <tr>
174          <td class="memname">void bdm::mepdf::from_setting           </td>
175          <td>(</td>
176          <td class="paramtype">const Setting &amp;&nbsp;</td>
177          <td class="paramname"> <em>set</em>          </td>
178          <td>&nbsp;)&nbsp;</td>
179          <td><code> [virtual]</code></td>
180        </tr>
181      </table>
182</div>
183<div class="memdoc">
184
185<p>
186Load from structure with elements:.
187<p>
188<div class="fragment"><pre class="fragment">         { <span class="keyword">class </span>= "<a class="code" href="classbdm_1_1mepdf.html#4a2b01e7bb510c6b8946757cae6c9155" title="Default constructor.">mepdf</a>",
189           epdf = {<span class="keyword">class</span>=<span class="stringliteral">"epdf_offspring"</span>,...}
190         }
191</pre></div> 
192<p>Reimplemented from <a class="el" href="classbdm_1_1mpdf.html#30a0bceb948e287d497c578e371b1667">bdm::mpdf</a>.</p>
193
194<p>References <a class="el" href="shared__ptr_8h_source.html#l00115">bdm::shared_ptr&lt; T &gt;::get()</a>, and <a class="el" href="bdmbase_8h_source.html#l00468">bdm::mpdf::set_ep()</a>.</p>
195
196</div>
197</div><p>
198<a class="anchor" name="6e497d501331057309d2fddf63259d1a"></a><!-- doxytag: member="bdm::mepdf::samplecond_m" ref="6e497d501331057309d2fddf63259d1a" args="(const vec &amp;cond, int N)" -->
199<div class="memitem">
200<div class="memproto">
201      <table class="memname">
202        <tr>
203          <td class="memname">mat bdm::mpdf::samplecond_m           </td>
204          <td>(</td>
205          <td class="paramtype">const vec &amp;&nbsp;</td>
206          <td class="paramname"> <em>cond</em>, </td>
207        </tr>
208        <tr>
209          <td class="paramkey"></td>
210          <td></td>
211          <td class="paramtype">int&nbsp;</td>
212          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
213        </tr>
214        <tr>
215          <td></td>
216          <td>)</td>
217          <td></td><td></td><td><code> [virtual, inherited]</code></td>
218        </tr>
219      </table>
220</div>
221<div class="memdoc">
222
223<p>
224Returns.
225<p>
226<dl compact><dt><b>Parameters:</b></dt><dd>
227  <table border="0" cellspacing="2" cellpadding="0">
228    <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_16.png">. </td></tr>
229    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
230  </table>
231</dl>
232
233<p>Reimplemented in <a class="el" href="classbdm_1_1mpdf__internal.html#9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; EPDF &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; egamma &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; enorm&lt; chmat &gt; &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; enorm&lt; sq_T &gt; &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; eigamma &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; elognorm &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; eiWishartCh &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; enorm&lt; ldmat &gt; &gt;</a>, <a class="el" href="classbdm_1_1mpdf__internal.html#9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; TEpdf&lt; sq_T &gt; &gt;</a>, and <a class="el" href="classbdm_1_1mpdf__internal.html#9554c554054da2d22cb8e908ae9c8823">bdm::mpdf_internal&lt; eDirich &gt;</a>.</p>
234
235<p>References <a class="el" href="bdmbase_8h_source.html#l00489">bdm::mpdf::samplecond()</a>.</p>
236
237</div>
238</div><p>
239<hr>The documentation for this class was generated from the following files:<ul>
240<li><a class="el" href="bdmbase_8h_source.html">bdmbase.h</a><li>bdmbase.cpp</ul>
241</div>
242<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:46 2009 for mixpp by&nbsp;
243<a href="http://www.doxygen.org/index.html">
244<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
245</body>
246</html>
Note: See TracBrowser for help on using the browser.