root/doc/html/classcompositepdf.html @ 224

Revision 224, 7.0 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[187]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: compositepdf 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>
[219]13      <li><a href="modules.html"><span>Modules</span></a></li>
[187]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>
26<div class="contents">
[219]27<h1>compositepdf Class Reference<br>
28<small>
29[<a class="el" href="group__core.html">Core BDM classes</a>]</small>
30</h1><!-- doxytag: class="compositepdf" -->Abstract composition of pdfs, a base for specific classes this abstract class is common to <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> and <a class="el" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a>. 
[187]31<a href="#_details">More...</a>
32<p>
33<code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
34<p>
35<div class="dynheader">
36Inheritance diagram for compositepdf:</div>
37<div class="dynsection">
38<p><center><img src="classcompositepdf__inherit__graph.png" border="0" usemap="#compositepdf__inherit__map" alt="Inheritance graph"></center>
39<map name="compositepdf__inherit__map">
40<area shape="rect" href="classmerger.html" title="Function for general combination of pdfs." alt="" coords="5,84,72,111"><area shape="rect" href="classmprod.html" title="Chain rule decomposition of epdf." alt="" coords="96,84,160,111"></map>
41<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
42
43<p>
44<a href="classcompositepdf-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
45<tr><td></td></tr>
46<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6ab00575b058fcf4d80090cb3c95351d"></a><!-- doxytag: member="compositepdf::compositepdf" ref="6ab00575b058fcf4d80090cb3c95351d" args="(Array&lt; mpdf * &gt; A0)" -->
48&nbsp;</td><td class="memItemRight" valign="bottom"><b>compositepdf</b> (Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt; A0)</td></tr>
49
50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#635d219fb3e32852400d6f98aa4bdc93">getrv</a> (bool checkoverlap=false)</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">find common rv, flag  <a href="#635d219fb3e32852400d6f98aa4bdc93"></a><br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a4479785c1fdb2cc351fbea07b899ac"></a><!-- doxytag: member="compositepdf::setrvc" ref="5a4479785c1fdb2cc351fbea07b899ac" args="(const RV &amp;rv, RV &amp;rvc)" -->
54void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#5a4479785c1fdb2cc351fbea07b899ac">setrvc</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv, <a class="el" href="classRV.html">RV</a> &amp;rvc)</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">common rvc of all mpdfs is written to rvc <br></td></tr>
57<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1646fe41ff5934d010e54ccaa46133f"></a><!-- doxytag: member="compositepdf::n" ref="c1646fe41ff5934d010e54ccaa46133f" args="" -->
59int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#c1646fe41ff5934d010e54ccaa46133f">n</a></td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of mpdfs in the composite. <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="637877061b917a16a0421bb5c4cd480d"></a><!-- doxytag: member="compositepdf::mpdfs" ref="637877061b917a16a0421bb5c4cd480d" args="" -->
63Array&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>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Elements of composition. <br></td></tr>
66</table>
67<hr><a name="_details"></a><h2>Detailed Description</h2>
[210]68Abstract composition of pdfs, a base for specific classes this abstract class is common to <a class="el" href="classepdf.html" title="Probability density function with numerical statistics, e.g. posterior density.">epdf</a> and <a class="el" href="classmpdf.html" title="Conditional probability density, e.g. modeling some dependencies.">mpdf</a>. <hr><h2>Member Function Documentation</h2>
[187]69<a class="anchor" name="635d219fb3e32852400d6f98aa4bdc93"></a><!-- doxytag: member="compositepdf::getrv" ref="635d219fb3e32852400d6f98aa4bdc93" args="(bool checkoverlap=false)" -->
70<div class="memitem">
71<div class="memproto">
72      <table class="memname">
73        <tr>
74          <td class="memname"><a class="el" href="classRV.html">RV</a> compositepdf::getrv           </td>
75          <td>(</td>
76          <td class="paramtype">bool&nbsp;</td>
77          <td class="paramname"> <em>checkoverlap</em> = <code>false</code>          </td>
78          <td>&nbsp;)&nbsp;</td>
79          <td></td>
80        </tr>
81      </table>
82</div>
83<div class="memdoc">
84
85<p>
86find common rv, flag
87<p>
88<dl compact><dt><b>Parameters:</b></dt><dd>
89  <table border="0" cellspacing="2" cellpadding="0">
90    <tr><td valign="top"></td><td valign="top"><em>checkoverlap</em>&nbsp;</td><td>modifies whether overlaps are acceptable </td></tr>
91  </table>
92</dl>
93
[224]94<p>References <a class="el" href="libBM_8cpp-source.html#l00053">RV::add()</a>, <a class="el" href="libBM_8h-source.html#l00360">mpdfs</a>, and <a class="el" href="libBM_8h-source.html#l00358">n</a>.</p>
[187]95
96</div>
97</div><p>
98<hr>The documentation for this class was generated from the following files:<ul>
99<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>
100</div>
[224]101<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:29:14 2009 for mixpp by&nbsp;
[187]102<a href="http://www.doxygen.org/index.html">
103<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
104</body>
105</html>
Note: See TracBrowser for help on using the browser.