root/doc/html/classmerger.html @ 180

Revision 180, 19.3 kB (checked in by smidl, 16 years ago)

Modifications of BDM to reflect changes in basics

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="compositepdf,epdf" -->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="classcompositepdf.html" title="Abstract composition of pdfs, a base for specific classes." alt="" coords="5,7,112,33"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="136,7,184,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="classcompositepdf.html" title="Abstract composition of pdfs, a base for specific classes." alt="" coords="5,481,112,508"><area shape="rect" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density." alt="" coords="187,103,235,129"><area shape="rect" href="classeprod.html" title="Product of independent epdfs. For dependent pdfs, use mprod." alt="" coords="171,236,229,263"><area shape="rect" href="classeEF.html" title="General conjugate exponential family posterior density." alt="" coords="241,183,284,209"><area shape="rect" href="classRV.html" title="Class representing variables, most often random variables." alt="" coords="252,7,289,33"><area shape="rect" href="classBM.html" title="Bayesian Model of the world, i.e. all uncertainty is modeled by probabilities." alt="" coords="333,183,373,209"><area shape="rect" href="classMixEF.html" title="Mixture of Exponential Family Densities." alt="" coords="215,481,271,508"><area shape="rect" href="classBMEF.html" title="Estimator for Exponential family." alt="" coords="325,289,381,316"><area shape="rect" href="classmultiBM.html" title="Estimator for Multinomial density." alt="" coords="237,385,309,412"><area shape="rect" href="classeDirich.html" title="Dirichlet posterior density." alt="" coords="237,289,301,316"></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="3f9a955329eab65026e8322e9027d469"></a><!-- doxytag: member="merger::merger" ref="3f9a955329eab65026e8322e9027d469" args="(const Array&lt; mpdf * &gt; &amp;S)" -->
51&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#3f9a955329eab65026e8322e9027d469">merger</a> (const Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt; &amp;S)</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"><a class="anchor" name="79420e251308df4502c834171d518ad9"></a><!-- doxytag: member="merger::set_parameters" ref="79420e251308df4502c834171d518ad9" args="(double beta0, int Ns0, int Nc0)" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#79420e251308df4502c834171d518ad9">set_parameters</a> (double beta0, int Ns0, int Nc0)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set internal parameters used in approximation. <br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="02d2a445e44a87f37ee3a2b9b40cffd1"></a><!-- doxytag: member="merger::init" ref="02d2a445e44a87f37ee3a2b9b40cffd1" args="()" -->
59void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#02d2a445e44a87f37ee3a2b9b40cffd1">init</a> ()</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the proposal density. This function must be called before <a class="el" href="classmerger.html#bc23accc77ec766bce7202934e2c180c" title="Create a mixture density, make sure to call init() before the first call.">merge()</a>! <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e56ad4a2bc9be2ddfc051626adf27715"></a><!-- doxytag: member="merger::merge" ref="e56ad4a2bc9be2ddfc051626adf27715" args="(const epdf *g0)" -->
63void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#e56ad4a2bc9be2ddfc051626adf27715">merge</a> (const <a class="el" href="classepdf.html">epdf</a> *g0)</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a mixture density using known proposal. <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc23accc77ec766bce7202934e2c180c"></a><!-- doxytag: member="merger::merge" ref="bc23accc77ec766bce7202934e2c180c" args="()" -->
67void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#bc23accc77ec766bce7202934e2c180c">merge</a> ()</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a mixture density, make sure to call <a class="el" href="classmerger.html#02d2a445e44a87f37ee3a2b9b40cffd1" title="Initialize the proposal density. This function must be called before merge()!">init()</a> before the first call. <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="217c65f335c603033fa09a2ecc64bc05"></a><!-- doxytag: member="merger::lognorm_merge" ref="217c65f335c603033fa09a2ecc64bc05" args="(mat &amp;lW)" -->
71vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#217c65f335c603033fa09a2ecc64bc05">lognorm_merge</a> (mat &amp;lW)</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Merge log-likelihood values. <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top">vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#379198c3d2063bfa63f5d1245a2511ba">sample</a> () const </td></tr>
75
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c37688902b1a1e9fa32edc5709e5a00"></a><!-- doxytag: member="merger::evalpdflog" ref="8c37688902b1a1e9fa32edc5709e5a00" args="(const vec &amp;dt) const " -->
77double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#8c37688902b1a1e9fa32edc5709e5a00">evalpdflog</a> (const vec &amp;dt) const </td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of argument <code>val</code>. <br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a46999cd77047d5d4ac6c1cb735a83e"></a><!-- doxytag: member="merger::mean" ref="3a46999cd77047d5d4ac6c1cb735a83e" args="() const " -->
81vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#3a46999cd77047d5d4ac6c1cb735a83e">mean</a> () const </td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51e425ee1dd46d73353526e6a1c24ca3"></a><!-- doxytag: member="merger::~merger" ref="51e425ee1dd46d73353526e6a1c24ca3" args="()" -->
85virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#51e425ee1dd46d73353526e6a1c24ca3">~merger</a> ()</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">for future use <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="635d219fb3e32852400d6f98aa4bdc93"></a><!-- doxytag: member="merger::getrv" ref="635d219fb3e32852400d6f98aa4bdc93" args="(bool checkoverlap=false)" -->
89<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>getrv</b> (bool checkoverlap=false)</td></tr>
90
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a4479785c1fdb2cc351fbea07b899ac"></a><!-- doxytag: member="merger::setrvc" ref="5a4479785c1fdb2cc351fbea07b899ac" args="(const RV &amp;rv, RV &amp;rvc)" -->
92void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setrvc</b> (const <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>, <a class="el" href="classRV.html">RV</a> &amp;rvc)</td></tr>
93
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08958c8f76d65de94ecc37b8d90bc77a"></a><!-- doxytag: member="merger::setindices" ref="08958c8f76d65de94ecc37b8d90bc77a" args="(const RV &amp;rv)" -->
95void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setindices</b> (const <a class="el" href="classRV.html">RV</a> &amp;<a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a>)</td></tr>
96
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bd4ada95f381ea6c4cff2dc86e957c4"></a><!-- doxytag: member="merger::setrvcinrv" ref="3bd4ada95f381ea6c4cff2dc86e957c4" args="(const RV &amp;rvc, Array&lt; ivec &gt; &amp;rvcind)" -->
98void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setrvcinrv</b> (const <a class="el" href="classRV.html">RV</a> &amp;rvc, Array&lt; ivec &gt; &amp;rvcind)</td></tr>
99
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="54d7dd53a641b618771cd9bee135181f"></a><!-- doxytag: member="merger::sampleN" ref="54d7dd53a641b618771cd9bee135181f" args="(int N) const " -->
101virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#54d7dd53a641b618771cd9bee135181f">sampleN</a> (int N) const </td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns N samples from density <img class="formulaInl" alt="$epdf(rv)$" src="form_59.png">. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ea597362e11a0040fe7c990269d072c"></a><!-- doxytag: member="merger::eval" ref="3ea597362e11a0040fe7c990269d072c" args="(const vec &amp;val) const " -->
105virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#3ea597362e11a0040fe7c990269d072c">eval</a> (const vec &amp;val) const </td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute probability of argument <code>val</code>. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cebbdd7a85e6328f7358fc0ba8eee06c"></a><!-- doxytag: member="merger::evalpdflog_m" ref="cebbdd7a85e6328f7358fc0ba8eee06c" args="(const mat &amp;Val) const " -->
109virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#cebbdd7a85e6328f7358fc0ba8eee06c">evalpdflog_m</a> (const mat &amp;Val) const </td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ca0d32aabb4cbba347e0c37fe8607562"></a><!-- doxytag: member="merger::_rv" ref="ca0d32aabb4cbba347e0c37fe8607562" args="() const " -->
113const <a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#ca0d32aabb4cbba347e0c37fe8607562">_rv</a> () const </td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function, possibly dangerous! <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7fb94ce90d1ac7077d29f7d6a6c3e0a5"></a><!-- doxytag: member="merger::_renewrv" ref="7fb94ce90d1ac7077d29f7d6a6c3e0a5" args="(const RV &amp;in_rv)" -->
117void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#7fb94ce90d1ac7077d29f7d6a6c3e0a5">_renewrv</a> (const <a class="el" href="classRV.html">RV</a> &amp;in_rv)</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modifier function - useful when copying epdfs <br></td></tr>
120<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="021d1522cea70db8545d708afd32ec2f"></a><!-- doxytag: member="merger::Mix" ref="021d1522cea70db8545d708afd32ec2f" args="" -->
122<a class="el" href="classMixEF.html">MixEF</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#021d1522cea70db8545d708afd32ec2f">Mix</a></td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal mixture of EF models. <br></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ce84de1824875b4262eefb640e8c6d69"></a><!-- doxytag: member="merger::Ns" ref="ce84de1824875b4262eefb640e8c6d69" args="" -->
126int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#ce84de1824875b4262eefb640e8c6d69">Ns</a></td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of samples used in approximation. <br></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6acf33e1c64aaaee20689725e8110f65"></a><!-- doxytag: member="merger::Nc" ref="6acf33e1c64aaaee20689725e8110f65" args="" -->
130int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#6acf33e1c64aaaee20689725e8110f65">Nc</a></td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of components in a mixture. <br></td></tr>
133<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e68a72e2740007ae68545e378c7701ad"></a><!-- doxytag: member="merger::beta" ref="e68a72e2740007ae68545e378c7701ad" args="" -->
134double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmerger.html#e68a72e2740007ae68545e378c7701ad">beta</a></td></tr>
135
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prior on the log-normal merging model. <br></td></tr>
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1646fe41ff5934d010e54ccaa46133f"></a><!-- doxytag: member="merger::n" ref="c1646fe41ff5934d010e54ccaa46133f" args="" -->
138int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#c1646fe41ff5934d010e54ccaa46133f">n</a></td></tr>
139
140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of mpdfs in the composite. <br></td></tr>
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="637877061b917a16a0421bb5c4cd480d"></a><!-- doxytag: member="merger::mpdfs" ref="637877061b917a16a0421bb5c4cd480d" args="" -->
142Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#637877061b917a16a0421bb5c4cd480d">mpdfs</a></td></tr>
143
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Elements of composition. <br></td></tr>
145<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d4a8269f9faefeca8cdc251a5a29a7f"></a><!-- doxytag: member="merger::rvsinrv" ref="4d4a8269f9faefeca8cdc251a5a29a7f" args="" -->
146Array&lt; ivec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#4d4a8269f9faefeca8cdc251a5a29a7f">rvsinrv</a></td></tr>
147
148<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indeces of rvs in common rv. <br></td></tr>
149<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3df07bb5e3ed36a3119b145043296676"></a><!-- doxytag: member="merger::rvcsinrv" ref="3df07bb5e3ed36a3119b145043296676" args="" -->
150Array&lt; ivec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#3df07bb5e3ed36a3119b145043296676">rvcsinrv</a></td></tr>
151
152<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indeces of rvc in common rv. <br></td></tr>
153<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74da992e3f5d598da8850b646b79b9d9"></a><!-- doxytag: member="merger::rv" ref="74da992e3f5d598da8850b646b79b9d9" args="" -->
154<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classepdf.html#74da992e3f5d598da8850b646b79b9d9">rv</a></td></tr>
155
156<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identified of the random variable. <br></td></tr>
157</table>
158<hr><a name="_details"></a><h2>Detailed Description</h2>
159Function for general combination of pdfs.
160<p>
161Mixtures of Gaussian densities are used internally. Switching to other densities should be trivial. <hr><h2>Member Function Documentation</h2>
162<a class="anchor" name="379198c3d2063bfa63f5d1245a2511ba"></a><!-- doxytag: member="merger::sample" ref="379198c3d2063bfa63f5d1245a2511ba" args="() const " -->
163<div class="memitem">
164<div class="memproto">
165      <table class="memname">
166        <tr>
167          <td class="memname">vec merger::sample           </td>
168          <td>(</td>
169          <td class="paramname">          </td>
170          <td>&nbsp;)&nbsp;</td>
171          <td> const<code> [inline, virtual]</code></td>
172        </tr>
173      </table>
174</div>
175<div class="memdoc">
176
177<p>
178sample from merged density weight w is a
179<p>Implements <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf</a>.</p>
180
181<p>References <a class="el" href="mixef_8h-source.html#l00092">MixEF::_epdf()</a>, <a class="el" href="merger_8h-source.html#l00031">Mix</a>, and <a class="el" href="classepdf.html#8019654e494bf5e458f6fb947e11b262">epdf::sample()</a>.</p>
182
183</div>
184</div><p>
185<hr>The documentation for this class was generated from the following files:<ul>
186<li>work/git/mixpp/bdm/estim/<a class="el" href="merger_8h-source.html">merger.h</a><li>work/git/mixpp/bdm/estim/merger.cpp</ul>
187</div>
188<hr size="1"><address style="text-align: right;"><small>Generated on Thu Oct 9 21:26:41 2008 for mixpp by&nbsp;
189<a href="http://www.doxygen.org/index.html">
190<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
191</body>
192</html>
Note: See TracBrowser for help on using the browser.