root/doc/html/classbdm_1_1epdf.html @ 259

Revision 259, 13.4 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::epdf 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><a href="modules.html"><span>Modules</span></a></li>
14      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
15      <li><a href="files.html"><span>Files</span></a></li>
16    </ul>
17  </div>
18  <div class="tabs">
19    <ul>
20      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23    </ul>
24  </div>
25  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1epdf.html">epdf</a>
26  </div>
27</div>
28<div class="contents">
29<h1>bdm::epdf Class Reference</h1><!-- doxytag: class="bdm::epdf" --><!-- doxytag: inherits="bdm::base" -->Probability density function with numerical statistics, e.g. posterior density. 
30<a href="#_details">More...</a>
31<p>
32<code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
33<p>
34<div class="dynheader">
35Inheritance diagram for bdm::epdf:</div>
36<div class="dynsection">
37<p><center><img src="classbdm_1_1epdf__inherit__graph.png" border="0" usemap="#bdm_1_1epdf__inherit__map" alt="Inheritance graph"></center>
38<map name="bdm_1_1epdf__inherit__map">
39<area shape="rect" href="classbdm_1_1eEF.html" title="General conjugate exponential family posterior density." alt="" coords="351,183,431,209"><area shape="rect" href="classbdm_1_1eEmp.html" title="Weighted empirical density." alt="" coords="343,233,439,260"><area shape="rect" href="classbdm_1_1emix.html" title="Mixture of epdfs." alt="" coords="347,284,435,311"><area shape="rect" href="classbdm_1_1eprod.html" title="Product of independent epdfs. For dependent pdfs, use mprod." alt="" coords="343,335,439,361"><area shape="rect" href="classbdm_1_1euni.html" title="Uniform distributed density on a rectangular support." alt="" coords="348,385,433,412"><area shape="rect" href="classbdm_1_1merger.html" title="Function for general combination of pdfs." alt="" coords="339,436,443,463"><area shape="rect" title="internal class for MPDF providing composition of eEmp with external components" alt="" coords="287,487,495,513"><area shape="rect" href="classbdm_1_1base.html" title="Root class of BDM objects." alt="" coords="7,335,95,361"><area shape="rect" href="classbdm_1_1eDirich.html" title="Dirichlet posterior density." alt="" coords="576,5,677,32"><area shape="rect" href="classbdm_1_1egamma.html" title="Gamma posterior density." alt="" coords="569,56,684,83"><area shape="rect" href="classbdm_1_1egiw.html" title="Gauss&#45;inverse&#45;Wishart density stored in LD form." alt="" coords="584,107,669,133"><area shape="rect" href="classbdm_1_1eigamma.html" title="Inverse&#45;Gamma posterior density." alt="" coords="567,157,687,184"><area shape="rect" href="classbdm_1_1enorm.html" title="Gaussian density with positive definite (decomposed) covariance matrix." alt="" coords="547,276,707,303"><area shape="rect" href="classbdm_1_1enorm.html" title="bdm::enorm\&lt; ldmat \&gt;" alt="" coords="833,233,1001,260"><area shape="rect" href="classbdm_1_1enorm.html" title="bdm::enorm\&lt; chmat \&gt;" alt="" coords="832,307,1003,333"><area shape="rect" href="classbdm_1_1enorm.html" title="bdm::enorm\&lt; fsqmat \&gt;" alt="" coords="829,401,1005,428"></map>
40<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
41<div class="dynheader">
42Collaboration diagram for bdm::epdf:</div>
43<div class="dynsection">
44<p><center><img src="classbdm_1_1epdf__coll__graph.png" border="0" usemap="#bdm_1_1epdf__coll__map" alt="Collaboration graph"></center>
45<map name="bdm_1_1epdf__coll__map">
46<area shape="rect" href="classbdm_1_1base.html" title="Root class of BDM objects." alt="" coords="9,7,97,33"><area shape="rect" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables." alt="" coords="64,87,139,113"></map>
47<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
48
49<p>
50<a href="classbdm_1_1epdf-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
51<tr><td></td></tr>
52<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="992f3de956fb3439c62225156aafb6f6"></a><!-- doxytag: member="bdm::epdf::epdf" ref="992f3de956fb3439c62225156aafb6f6" args="()" -->
54&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#992f3de956fb3439c62225156aafb6f6">epdf</a> ()</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fdfed7aa18f2870951888b1dde977415"></a><!-- doxytag: member="bdm::epdf::epdf" ref="fdfed7aa18f2870951888b1dde977415" args="(const RV &amp;rv0)" -->
58&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#fdfed7aa18f2870951888b1dde977415">epdf</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv0)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="09721eb148bc49d6ec2f1956039f3a10"></a><!-- doxytag: member="bdm::epdf::sample" ref="09721eb148bc49d6ec2f1956039f3a10" args="() const =0" -->
62virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#09721eb148bc49d6ec2f1956039f3a10">sample</a> () const =0</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a sample, <img class="formulaInl" alt="$x$" src="form_28.png"> from density <img class="formulaInl" alt="$epdf(rv)$" src="form_59.png">. <br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4cf45fd83cc7573ede9fe1215256058"></a><!-- doxytag: member="bdm::epdf::sample_m" ref="b4cf45fd83cc7573ede9fe1215256058" args="(int N) const " -->
66virtual mat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#b4cf45fd83cc7573ede9fe1215256058">sample_m</a> (int N) const </td></tr>
67
68<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>
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8e39e2ff5e5cf5471bc159530d3b2d3"></a><!-- doxytag: member="bdm::epdf::evallog" ref="a8e39e2ff5e5cf5471bc159530d3b2d3" args="(const vec &amp;val) const =0" -->
70virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a8e39e2ff5e5cf5471bc159530d3b2d3">evallog</a> (const vec &amp;val) const =0</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of argument <code>val</code>. <br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34956d4dd3176eeb5937cf48a1546b62"></a><!-- doxytag: member="bdm::epdf::evallog_m" ref="34956d4dd3176eeb5937cf48a1546b62" args="(const mat &amp;Val) const " -->
74virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#34956d4dd3176eeb5937cf48a1546b62">evallog_m</a> (const mat &amp;Val) const </td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute log-probability of multiple values argument <code>val</code>. <br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e584eac5579c1b6384947ecf66166c77"></a><!-- doxytag: member="bdm::epdf::condition" ref="e584eac5579c1b6384947ecf66166c77" args="(const RV &amp;rv) const " -->
78virtual <a class="el" href="classbdm_1_1mpdf.html">mpdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#e584eac5579c1b6384947ecf66166c77">condition</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;<a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a>) const </td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return conditional density on the given <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a>, the remaining rvs will be in conditioning. <br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3fb2ece54f720b62ad325e61214fa0a1"></a><!-- doxytag: member="bdm::epdf::marginal" ref="3fb2ece54f720b62ad325e61214fa0a1" args="(const RV &amp;rv) const " -->
82virtual <a class="el" href="classbdm_1_1epdf.html">epdf</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#3fb2ece54f720b62ad325e61214fa0a1">marginal</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;<a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a>) const </td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return marginal density on the given <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a>, the remainig rvs are intergrated out. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="565300f603ca00c989e16389d9eb42f5"></a><!-- doxytag: member="bdm::epdf::mean" ref="565300f603ca00c989e16389d9eb42f5" args="() const =0" -->
86virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#565300f603ca00c989e16389d9eb42f5">mean</a> () const =0</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected value <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="45c2b64faa4bf526799e4154a6ec6097"></a><!-- doxytag: member="bdm::epdf::variance" ref="45c2b64faa4bf526799e4154a6ec6097" args="() const =0" -->
90virtual vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#45c2b64faa4bf526799e4154a6ec6097">variance</a> () const =0</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return expected variance (not covariance!) <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4fa8637e7307cb051c400c2ce0ca0c8"></a><!-- doxytag: member="bdm::epdf::~epdf" ref="a4fa8637e7307cb051c400c2ce0ca0c8" args="()" -->
94virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a4fa8637e7307cb051c400c2ce0ca0c8">~epdf</a> ()</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor for future use;. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4ab378d5e004c3ff3e2d4e64f7bba21"></a><!-- doxytag: member="bdm::epdf::_rv" ref="a4ab378d5e004c3ff3e2d4e64f7bba21" args="() const " -->
98const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#a4ab378d5e004c3ff3e2d4e64f7bba21">_rv</a> () const </td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function, possibly dangerous! <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62e88cbce0ce77a8692f5e15d76e805f"></a><!-- doxytag: member="bdm::epdf::_renewrv" ref="62e88cbce0ce77a8692f5e15d76e805f" args="(const RV &amp;in_rv)" -->
102void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#62e88cbce0ce77a8692f5e15d76e805f">_renewrv</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;in_rv)</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">modifier function - useful when copying epdfs <br></td></tr>
105<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62c5b8ff71d9ebe6cd58d3c342eb1dc8"></a><!-- doxytag: member="bdm::epdf::rv" ref="62c5b8ff71d9ebe6cd58d3c342eb1dc8" args="" -->
107<a class="el" href="classbdm_1_1RV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1epdf.html#62c5b8ff71d9ebe6cd58d3c342eb1dc8">rv</a></td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identified of the random variable. <br></td></tr>
110</table>
111<hr><a name="_details"></a><h2>Detailed Description</h2>
112Probability density function with numerical statistics, e.g. posterior density. <hr>The documentation for this class was generated from the following files:<ul>
113<li>work/git/mixpp/bdm/stat/<a class="el" href="libBM_8h-source.html">libBM.h</a><li>work/git/mixpp/bdm/stat/libBM.cpp</ul>
114</div>
115<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 27 16:31:14 2009 for mixpp by&nbsp;
116<a href="http://www.doxygen.org/index.html">
117<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
118</body>
119</html>
Note: See TracBrowser for help on using the browser.