root/doc/html/classbdm_1_1mmix.html @ 368

Revision 368, 19.2 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::mmix 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_1mmix.html">mmix</a>
68  </div>
69</div>
70<div class="contents">
71<h1>bdm::mmix Class Reference</h1><!-- doxytag: class="bdm::mmix" --><!-- doxytag: inherits="bdm::mpdf" -->Mixture of mpdfs with constant weights, all mpdfs are of equal type. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="emix_8h-source.html">emix.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classbdm_1_1mmix-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="a0cf51b7daeb6751103e94e6b96213fb"></a><!-- doxytag: member="bdm::mmix::mmix" ref="a0cf51b7daeb6751103e94e6b96213fb" args="()" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#a0cf51b7daeb6751103e94e6b96213fb">mmix</a> ()</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad8d9df36cb0ca093a29af0eca12da32"></a><!-- doxytag: member="bdm::mmix::set_parameters" ref="ad8d9df36cb0ca093a29af0eca12da32" args="(const vec &amp;w, const Array&lt; mpdf * &gt; &amp;Coms)" -->
86void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#ad8d9df36cb0ca093a29af0eca12da32">set_parameters</a> (const vec &amp;w, const Array&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> * &gt; &amp;<a class="el" href="classbdm_1_1mmix.html#52e0bcc70d5b26babeba08097579da9c">Coms</a>)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set weights <code>w</code> and components <code>R</code>. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a5241ecc9911e816b00b92d5c7c8df0"></a><!-- doxytag: member="bdm::mmix::condition" ref="0a5241ecc9911e816b00b92d5c7c8df0" args="(const vec &amp;cond)" -->
90void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#0a5241ecc9911e816b00b92d5c7c8df0">condition</a> (const vec &amp;cond)</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 class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::mmix::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" -->
94virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::mmix::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" -->
98virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">from_setting</a> (const Setting &amp;root)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::mmix::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " -->
102virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#dd74cb898b22b95b7ee528e040a07618">to_setting</a> (Setting &amp;root) const </td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::mmix::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" -->
106virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
109<tr><td colspan="2"><div class="groupHeader">Matematical operations</div></td></tr>
110<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>
111
112<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_49.png">.  <a href="#f0c1db6fcbb3aae2dd6123884457a367"></a><br></td></tr>
113<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>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#afe4185b26baeb03688202e254d3b005"></a><br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6336a8a72462e2a56a3989a220f18b1b"></a><!-- doxytag: member="bdm::mmix::evallogcond" ref="6336a8a72462e2a56a3989a220f18b1b" args="(const vec &amp;dt, const vec &amp;cond)" -->
117virtual 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>
118
119<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>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b0ed1ed663071bb7cf4a1349eb94fcb"></a><!-- doxytag: member="bdm::mmix::evallogcond_m" ref="0b0ed1ed663071bb7cf4a1349eb94fcb" args="(const mat &amp;Dt, const vec &amp;cond)" -->
121virtual 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>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Matrix version of evallogcond. <br></td></tr>
124<tr><td colspan="2"><div class="groupHeader">Access to attributes</div></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5571482d150fbcb72cc36f6694ce1a10"></a><!-- doxytag: member="bdm::mmix::_rv" ref="5571482d150fbcb72cc36f6694ce1a10" args="()" -->
126<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rv</b> ()</td></tr>
127
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26001264236846897bd11e4baad47245"></a><!-- doxytag: member="bdm::mmix::_rvc" ref="26001264236846897bd11e4baad47245" args="()" -->
129<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_rvc</b> ()</td></tr>
130
131<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c2bae3e1e90874e72941863974ec0ed"></a><!-- doxytag: member="bdm::mmix::dimension" ref="1c2bae3e1e90874e72941863974ec0ed" args="()" -->
132int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimension</b> ()</td></tr>
133
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="35e135910aed187b7290742f50e61bc8"></a><!-- doxytag: member="bdm::mmix::dimensionc" ref="35e135910aed187b7290742f50e61bc8" args="()" -->
135int&nbsp;</td><td class="memItemRight" valign="bottom"><b>dimensionc</b> ()</td></tr>
136
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1892fe3933488942253679f068e9e7f6"></a><!-- doxytag: member="bdm::mmix::_epdf" ref="1892fe3933488942253679f068e9e7f6" args="()" -->
138<a class="el" href="classbdm_1_1epdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>_epdf</b> ()</td></tr>
139
140<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05e843fd11c410a99dad2b88c55aca80"></a><!-- doxytag: member="bdm::mmix::_e" ref="05e843fd11c410a99dad2b88c55aca80" args="()" -->
141<a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>_e</b> ()</td></tr>
142
143<tr><td colspan="2"><div class="groupHeader">Connection to other objects</div></td></tr>
144<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7631a5570e4ade1420065e8df78f4401"></a><!-- doxytag: member="bdm::mmix::set_rvc" ref="7631a5570e4ade1420065e8df78f4401" args="(const RV &amp;rvc0)" -->
145void&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>
146
147<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18ac26bc2f96ae01ef4eb06178abbd75"></a><!-- doxytag: member="bdm::mmix::set_rv" ref="18ac26bc2f96ae01ef4eb06178abbd75" args="(const RV &amp;rv0)" -->
148void&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>
149
150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f8e3798150b42fd1f3e16ddbbe0e7045"></a><!-- doxytag: member="bdm::mmix::isnamed" ref="f8e3798150b42fd1f3e16ddbbe0e7045" args="()" -->
151bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isnamed</b> ()</td></tr>
152
153<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
154<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52e0bcc70d5b26babeba08097579da9c"></a><!-- doxytag: member="bdm::mmix::Coms" ref="52e0bcc70d5b26babeba08097579da9c" args="" -->
155Array&lt; <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#52e0bcc70d5b26babeba08097579da9c">Coms</a></td></tr>
156
157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Component (epdfs). <br></td></tr>
158<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c4dd6ca6556ddd8ae3c5f3257c04b60"></a><!-- doxytag: member="bdm::mmix::Epdf" ref="0c4dd6ca6556ddd8ae3c5f3257c04b60" args="" -->
159<a class="el" href="classbdm_1_1emix.html">emix</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mmix.html#0c4dd6ca6556ddd8ae3c5f3257c04b60">Epdf</a></td></tr>
160
161<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>. <br></td></tr>
162<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7c1900976ff13dbc09c9729b3bbff9e6"></a><!-- doxytag: member="bdm::mmix::dimc" ref="7c1900976ff13dbc09c9729b3bbff9e6" args="" -->
163int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mpdf.html#7c1900976ff13dbc09c9729b3bbff9e6">dimc</a></td></tr>
164
165<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">dimension of the condition <br></td></tr>
166<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f08950daa08b85b01ddf4e1c36288"></a><!-- doxytag: member="bdm::mmix::rvc" ref="5a5f08950daa08b85b01ddf4e1c36288" args="" -->
167<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>
168
169<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
170<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5eea43c56d38e4441bfb30270db949c0"></a><!-- doxytag: member="bdm::mmix::ep" ref="5eea43c56d38e4441bfb30270db949c0" args="" -->
171<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>
172
173<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>
174</table>
175<hr><a name="_details"></a><h2>Detailed Description</h2>
176Mixture of mpdfs with constant weights, all mpdfs are of equal type.
177<p>
178<hr><h2>Member Function Documentation</h2>
179<a class="anchor" name="f0c1db6fcbb3aae2dd6123884457a367"></a><!-- doxytag: member="bdm::mmix::samplecond" ref="f0c1db6fcbb3aae2dd6123884457a367" args="(const vec &amp;cond)" -->
180<div class="memitem">
181<div class="memproto">
182      <table class="memname">
183        <tr>
184          <td class="memname">virtual vec bdm::mpdf::samplecond           </td>
185          <td>(</td>
186          <td class="paramtype">const vec &amp;&nbsp;</td>
187          <td class="paramname"> <em>cond</em>          </td>
188          <td>&nbsp;)&nbsp;</td>
189          <td><code> [inline, virtual, inherited]</code></td>
190        </tr>
191      </table>
192</div>
193<div class="memdoc">
194
195<p>
196Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_49.png">.
197<p>
198<dl compact><dt><b>Parameters:</b></dt><dd>
199  <table border="0" cellspacing="2" cellpadding="0">
200    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
201  </table>
202</dl>
203
204<p>Reimplemented in <a class="el" href="classbdm_1_1mprod.html#ee715a8013acf9892f6cb489db595555">bdm::mprod</a>.</p>
205
206<p>References <a class="el" href="libBM_8h-source.html#l00345">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00318">bdm::mpdf::ep</a>, and <a class="el" href="libBM_8h-source.html#l00258">bdm::epdf::sample()</a>.</p>
207
208<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#l00044">bdm::ArxDS::step()</a>.</p>
209
210</div>
211</div><p>
212<a class="anchor" name="afe4185b26baeb03688202e254d3b005"></a><!-- doxytag: member="bdm::mmix::samplecond_m" ref="afe4185b26baeb03688202e254d3b005" args="(const vec &amp;cond, int N)" -->
213<div class="memitem">
214<div class="memproto">
215      <table class="memname">
216        <tr>
217          <td class="memname">virtual mat bdm::mpdf::samplecond_m           </td>
218          <td>(</td>
219          <td class="paramtype">const vec &amp;&nbsp;</td>
220          <td class="paramname"> <em>cond</em>, </td>
221        </tr>
222        <tr>
223          <td class="paramkey"></td>
224          <td></td>
225          <td class="paramtype">int&nbsp;</td>
226          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
227        </tr>
228        <tr>
229          <td></td>
230          <td>)</td>
231          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
232        </tr>
233      </table>
234</div>
235<div class="memdoc">
236
237<p>
238Returns.
239<p>
240<dl compact><dt><b>Parameters:</b></dt><dd>
241  <table border="0" cellspacing="2" cellpadding="0">
242    <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_49.png">. </td></tr>
243    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
244  </table>
245</dl>
246
247<p>References <a class="el" href="libBM_8h-source.html#l00345">bdm::mpdf::condition()</a>, <a class="el" href="libBM_8h-source.html#l00302">bdm::epdf::dimension()</a>, <a class="el" href="libBM_8h-source.html#l00318">bdm::mpdf::ep</a>, and <a class="el" href="libBM_8h-source.html#l00258">bdm::epdf::sample()</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="emix_8h-source.html">emix.h</a></ul>
253</div>
254<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 8 18:02:35 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.