root/doc/html/classmerger.html @ 174

Revision 171, 19.1 kB (checked in by smidl, 16 years ago)

New documentation

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: merger Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14      <li><a href="files.html"><span>Files</span></a></li>
15    </ul>
16  </div>
17  <div class="tabs">
18    <ul>
19      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
20      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
21      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
22    </ul>
23  </div>
24</div>
25<div class="contents">
26<h1>merger Class Reference</h1><!-- doxytag: class="merger" --><!-- doxytag: inherits="mprod" -->Function for general combination of pdfs. 
27<a href="#_details">More...</a>
28<p>
29<code>#include &lt;<a class="el" href="merger_8h-source.html">merger.h</a>&gt;</code>
30<p>
31<div class="dynheader">
32Inheritance diagram for merger:</div>
33<div class="dynsection">
34<p><center><img src="classmerger__inherit__graph.png" border="0" usemap="#merger__inherit__map" alt="Inheritance graph"></center>
35<map name="merger__inherit__map">
36<area shape="rect" href="classmprod.html" title="Chain rule decomposition of epdf." alt="" coords="7,84,71,111"><area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="12,7,65,33"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38<div class="dynheader">
39Collaboration diagram for merger:</div>
40<div class="dynsection">
41<p><center><img src="classmerger__coll__graph.png" border="0" usemap="#merger__coll__map" alt="Collaboration graph"></center>
42<map name="merger__coll__map">
43<area shape="rect" href="classmprod.html" title="Chain rule decomposition of epdf." alt="" coords="13,353,77,380"><area shape="rect" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies." alt="" coords="5,204,59,231"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="40,7,77,33"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="75,105,123,132"><area shape="rect" href="classeEF.html" title="General conjugate exponential family posterior density." alt="" coords="163,204,205,231"><area shape="rect" href="classenorm.html" title="enorm\&lt; fsqmat \&gt;" alt="" coords="135,407,273,433"><area shape="rect" href="classenorm.html" title="Gaussian density with positive definite (decomposed) covariance matrix." alt="" coords="63,300,185,327"><area shape="rect" href="classfsqmat.html" title="Fake sqmat. This class maps sqmat operations to operations on full matrix." alt="" coords="260,300,327,327"><area shape="rect" href="classsqmat.html" title="Virtual class for representation of double symmetric matrices in square&#45;root form..." alt="" coords="263,204,324,231"></map>
44<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
45
46<p>
47<a href="classmerger-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
48<tr><td></td></tr>
49<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a6a721294321c2e412ca0084c636b69"></a><!-- doxytag: member="merger::merger" ref="1a6a721294321c2e412ca0084c636b69" args="(const Array&lt; mpdf * &gt; &amp;in_sources)" -->
51&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#1a6a721294321c2e412ca0084c636b69">merger</a> (const Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt; &amp;in_sources)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#51e425ee1dd46d73353526e6a1c24ca3">~merger</a> ()</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">for future use  <a href="#51e425ee1dd46d73353526e6a1c24ca3"></a><br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c15df5d0c7bb9dc82dd78f037b2550a8"></a><!-- doxytag: member="merger::evalpdflog" ref="c15df5d0c7bb9dc82dd78f037b2550a8" args="(const vec &amp;val) const " -->
58double&nbsp;</td><td class="memItemRight" valign="bottom"><b>evalpdflog</b> (const vec &amp;val) const </td></tr>
59
60<tr><td class="memItemLeft" nowrap align="right" valign="top">vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmprod.html#a48887eb8738a9e5550bfc38eb8e9d68">samplecond</a> (const vec &amp;cond, double &amp;ll)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the required moment of the <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.  <a href="#a48887eb8738a9e5550bfc38eb8e9d68"></a><br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top">mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmprod.html#e171c40e210539c2af01d6237785620b">samplecond</a> (const vec &amp;cond, vec &amp;ll, int N)</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns.  <a href="#e171c40e210539c2af01d6237785620b"></a><br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f95a0cc6ab40611f46804682446ed83"></a><!-- doxytag: member="merger::condition" ref="0f95a0cc6ab40611f46804682446ed83" args="(const vec &amp;cond)" -->
67virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#0f95a0cc6ab40611f46804682446ed83">condition</a> (const vec &amp;cond)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update <code>ep</code> so that it represents this <a class="el" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a> conditioned on <code>rvc</code> = cond. <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="80b738ece5bd4f8c4edaee4b38906f91"></a><!-- doxytag: member="merger::evalcond" ref="80b738ece5bd4f8c4edaee4b38906f91" args="(const vec &amp;dt, const vec &amp;cond)" -->
71virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#80b738ece5bd4f8c4edaee4b38906f91">evalcond</a> (const vec &amp;dt, const vec &amp;cond)</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shortcut for conditioning and evaluation of the internal <a class="el" href="classepdf.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>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ec9c850305984582548e8deb64f0ffe8"></a><!-- doxytag: member="merger::_rvc" ref="ec9c850305984582548e8deb64f0ffe8" args="()" -->
75<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#ec9c850305984582548e8deb64f0ffe8">_rvc</a> ()</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1e71ad4c66d5884c82d4a3b06b42fe32"></a><!-- doxytag: member="merger::_rv" ref="1e71ad4c66d5884c82d4a3b06b42fe32" args="()" -->
79<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#1e71ad4c66d5884c82d4a3b06b42fe32">_rv</a> ()</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e17780ee5b2cfe05922a6c56af1462f8"></a><!-- doxytag: member="merger::_epdf" ref="e17780ee5b2cfe05922a6c56af1462f8" args="()" -->
83<a class="el" href="classepdf.html">epdf</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#e17780ee5b2cfe05922a6c56af1462f8">_epdf</a> ()</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
86<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1712341746811f2844de5499817abb46"></a><!-- doxytag: member="merger::condpdf" ref="1712341746811f2844de5499817abb46" args="" -->
88<a class="el" href="classenorm.html">enorm</a>&lt; <a class="el" href="classfsqmat.html">fsqmat</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#1712341746811f2844de5499817abb46">condpdf</a></td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Additional pdf on the part in condition (if undefined);. <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11eb177ef6409926b2ba3b4630bceab1"></a><!-- doxytag: member="merger::overlaps" ref="11eb177ef6409926b2ba3b4630bceab1" args="" -->
92Array&lt; ivec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#11eb177ef6409926b2ba3b4630bceab1">overlaps</a></td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find potential overlaps in rv. <br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7dcf1dde4a220f8c7b97ed987bff6c1f"></a><!-- doxytag: member="merger::n" ref="7dcf1dde4a220f8c7b97ed987bff6c1f" args="" -->
96int&nbsp;</td><td class="memItemRight" valign="bottom"><b>n</b></td></tr>
97
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0883ce383e8475546df138719918f70e"></a><!-- doxytag: member="merger::epdfs" ref="0883ce383e8475546df138719918f70e" args="" -->
99Array&lt; <a class="el" href="classepdf.html">epdf</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>epdfs</b></td></tr>
100
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2389c7585ac5d0d79587625186818889"></a><!-- doxytag: member="merger::mpdfs" ref="2389c7585ac5d0d79587625186818889" args="" -->
102Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>mpdfs</b></td></tr>
103
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8f78fbcdb4e38ecd3197d2958082497"></a><!-- doxytag: member="merger::rvinds" ref="c8f78fbcdb4e38ecd3197d2958082497" args="" -->
105Array&lt; ivec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmprod.html#c8f78fbcdb4e38ecd3197d2958082497">rvinds</a></td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indeces of rvs in common rv. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1725c7b497a27ab3c4889b846666b516"></a><!-- doxytag: member="merger::rvcinrv" ref="1725c7b497a27ab3c4889b846666b516" args="" -->
109Array&lt; ivec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmprod.html#1725c7b497a27ab3c4889b846666b516">rvcinrv</a></td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indeces of rvc in common rv. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc85192d8abc01832937ed8b62e363a6"></a><!-- doxytag: member="merger::rvcinds" ref="cc85192d8abc01832937ed8b62e363a6" args="" -->
113Array&lt; ivec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmprod.html#cc85192d8abc01832937ed8b62e363a6">rvcinds</a></td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indeces of rvc in common rvc. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6687c07ff07d47812dd565368ca59eb"></a><!-- doxytag: member="merger::rv" ref="f6687c07ff07d47812dd565368ca59eb" args="" -->
117<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#f6687c07ff07d47812dd565368ca59eb">rv</a></td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modeled random variable <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acb7dda792b3cd5576f39fa3129abbab"></a><!-- doxytag: member="merger::rvc" ref="acb7dda792b3cd5576f39fa3129abbab" args="" -->
121<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#acb7dda792b3cd5576f39fa3129abbab">rvc</a></td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">random variable in condition <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7aa894208a32f3487827df6d5054424c"></a><!-- doxytag: member="merger::ep" ref="7aa894208a32f3487827df6d5054424c" args="" -->
125<a class="el" href="classepdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmpdf.html#7aa894208a32f3487827df6d5054424c">ep</a></td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pointer to internal <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> <br></td></tr>
128</table>
129<hr><a name="_details"></a><h2>Detailed Description</h2>
130Function for general combination of pdfs.
131<p>
132Parent of simple arithmentic or geometric combinations <hr><h2>Constructor &amp; Destructor Documentation</h2>
133<a class="anchor" name="51e425ee1dd46d73353526e6a1c24ca3"></a><!-- doxytag: member="merger::~merger" ref="51e425ee1dd46d73353526e6a1c24ca3" args="()" -->
134<div class="memitem">
135<div class="memproto">
136      <table class="memname">
137        <tr>
138          <td class="memname">virtual merger::~merger           </td>
139          <td>(</td>
140          <td class="paramname">          </td>
141          <td>&nbsp;)&nbsp;</td>
142          <td><code> [inline, virtual]</code></td>
143        </tr>
144      </table>
145</div>
146<div class="memdoc">
147
148<p>
149for future use
150<p>
151sample from merged density weight w is a
152</div>
153</div><p>
154<hr><h2>Member Function Documentation</h2>
155<a class="anchor" name="a48887eb8738a9e5550bfc38eb8e9d68"></a><!-- doxytag: member="merger::samplecond" ref="a48887eb8738a9e5550bfc38eb8e9d68" args="(const vec &amp;cond, double &amp;ll)" -->
156<div class="memitem">
157<div class="memproto">
158      <table class="memname">
159        <tr>
160          <td class="memname">vec mprod::samplecond           </td>
161          <td>(</td>
162          <td class="paramtype">const vec &amp;&nbsp;</td>
163          <td class="paramname"> <em>cond</em>, </td>
164        </tr>
165        <tr>
166          <td class="paramkey"></td>
167          <td></td>
168          <td class="paramtype">double &amp;&nbsp;</td>
169          <td class="paramname"> <em>ll</em></td><td>&nbsp;</td>
170        </tr>
171        <tr>
172          <td></td>
173          <td>)</td>
174          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
175        </tr>
176      </table>
177</div>
178<div class="memdoc">
179
180<p>
181Returns the required moment of the <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a>.
182<p>
183Returns a sample from the density conditioned on <code>cond</code>, <img class="formulaInl" alt="$x \sim epdf(rv|cond)$" src="form_10.png">. <dl compact><dt><b>Parameters:</b></dt><dd>
184  <table border="0" cellspacing="2" cellpadding="0">
185    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
186    <tr><td valign="top"></td><td valign="top"><em>ll</em>&nbsp;</td><td>is a return value of log-likelihood of the sample. </td></tr>
187  </table>
188</dl>
189
190<p>Reimplemented from <a class="el" href="classmpdf.html#3f172b79ec4a5ebc87898a5381141f1b">mpdf</a>.</p>
191
192<p>References <a class="el" href="libBM_8h-source.html#l00069">RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00186">mpdf::rv</a>, <a class="el" href="emix_8h-source.html#l00083">mprod::rvcinds</a>, <a class="el" href="emix_8h-source.html#l00081">mprod::rvcinrv</a>, and <a class="el" href="emix_8h-source.html#l00079">mprod::rvinds</a>.</p>
193
194<p>Referenced by <a class="el" href="emix_8h-source.html#l00128">mprod::samplecond()</a>.</p>
195
196</div>
197</div><p>
198<a class="anchor" name="e171c40e210539c2af01d6237785620b"></a><!-- doxytag: member="merger::samplecond" ref="e171c40e210539c2af01d6237785620b" args="(const vec &amp;cond, vec &amp;ll, int N)" -->
199<div class="memitem">
200<div class="memproto">
201      <table class="memname">
202        <tr>
203          <td class="memname">mat mprod::samplecond           </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">vec &amp;&nbsp;</td>
212          <td class="paramname"> <em>ll</em>, </td>
213        </tr>
214        <tr>
215          <td class="paramkey"></td>
216          <td></td>
217          <td class="paramtype">int&nbsp;</td>
218          <td class="paramname"> <em>N</em></td><td>&nbsp;</td>
219        </tr>
220        <tr>
221          <td></td>
222          <td>)</td>
223          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
224        </tr>
225      </table>
226</div>
227<div class="memdoc">
228
229<p>
230Returns.
231<p>
232<dl compact><dt><b>Parameters:</b></dt><dd>
233  <table border="0" cellspacing="2" cellpadding="0">
234    <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_10.png">. </td></tr>
235    <tr><td valign="top"></td><td valign="top"><em>cond</em>&nbsp;</td><td>is numeric value of <code>rv</code> </td></tr>
236    <tr><td valign="top"></td><td valign="top"><em>ll</em>&nbsp;</td><td>is a return value of log-likelihood of the sample. </td></tr>
237  </table>
238</dl>
239
240<p>Reimplemented from <a class="el" href="classmpdf.html#0e37163660f93df2a4d723cedb1da89c">mpdf</a>.</p>
241
242<p>References <a class="el" href="libBM_8h-source.html#l00069">RV::count()</a>, <a class="el" href="libBM_8h-source.html#l00186">mpdf::rv</a>, and <a class="el" href="emix_8h-source.html#l00105">mprod::samplecond()</a>.</p>
243
244</div>
245</div><p>
246<hr>The documentation for this class was generated from the following file:<ul>
247<li>work/git/mixpp/bdm/stat/<a class="el" href="merger_8h-source.html">merger.h</a></ul>
248</div>
249<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 23 16:00:53 2008 for mixpp by&nbsp;
250<a href="http://www.doxygen.org/index.html">
251<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
252</body>
253</html>
Note: See TracBrowser for help on using the browser.