root/doc/html/classcompositepdf.html @ 187

Revision 187, 8.9 kB (checked in by smidl, 16 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: 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>
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>compositepdf Class Reference</h1><!-- doxytag: class="compositepdf" -->Abstract composition of pdfs, a base for specific classes. 
27<a href="#_details">More...</a>
28<p>
29<code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
30<p>
31<div class="dynheader">
32Inheritance diagram for compositepdf:</div>
33<div class="dynsection">
34<p><center><img src="classcompositepdf__inherit__graph.png" border="0" usemap="#compositepdf__inherit__map" alt="Inheritance graph"></center>
35<map name="compositepdf__inherit__map">
36<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>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38
39<p>
40<a href="classcompositepdf-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
41<tr><td></td></tr>
42<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
43<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)" -->
44&nbsp;</td><td class="memItemRight" valign="bottom"><b>compositepdf</b> (Array&lt; <a class="el" href="classmpdf.html">mpdf</a> * &gt; A0)</td></tr>
45
46<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>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">find common rv, flag  <a href="#635d219fb3e32852400d6f98aa4bdc93"></a><br></td></tr>
49<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)" -->
50void&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>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">common rvc of all mpdfs is written to rvc <br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08958c8f76d65de94ecc37b8d90bc77a"></a><!-- doxytag: member="compositepdf::setindices" ref="08958c8f76d65de94ecc37b8d90bc77a" args="(const RV &amp;rv)" -->
54void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#08958c8f76d65de94ecc37b8d90bc77a">setindices</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv)</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">fill all rv*inrv* according to <br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bd4ada95f381ea6c4cff2dc86e957c4"></a><!-- doxytag: member="compositepdf::setrvcinrv" ref="3bd4ada95f381ea6c4cff2dc86e957c4" args="(const RV &amp;rvc, Array&lt; ivec &gt; &amp;rvcind)" -->
58void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#3bd4ada95f381ea6c4cff2dc86e957c4">setrvcinrv</a> (const <a class="el" href="classRV.html">RV</a> &amp;rvc, Array&lt; ivec &gt; &amp;rvcind)</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function fills Array by indeces of mpdfs inside given rv. <br></td></tr>
61<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1646fe41ff5934d010e54ccaa46133f"></a><!-- doxytag: member="compositepdf::n" ref="c1646fe41ff5934d010e54ccaa46133f" args="" -->
63int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#c1646fe41ff5934d010e54ccaa46133f">n</a></td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of mpdfs in the composite. <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="637877061b917a16a0421bb5c4cd480d"></a><!-- doxytag: member="compositepdf::mpdfs" ref="637877061b917a16a0421bb5c4cd480d" args="" -->
67Array&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>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Elements of composition. <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d4a8269f9faefeca8cdc251a5a29a7f"></a><!-- doxytag: member="compositepdf::rvsinrv" ref="4d4a8269f9faefeca8cdc251a5a29a7f" args="" -->
71Array&lt; ivec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#4d4a8269f9faefeca8cdc251a5a29a7f">rvsinrv</a></td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indeces of rvs in common rv. <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3df07bb5e3ed36a3119b145043296676"></a><!-- doxytag: member="compositepdf::rvcsinrv" ref="3df07bb5e3ed36a3119b145043296676" args="" -->
75Array&lt; ivec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#3df07bb5e3ed36a3119b145043296676">rvcsinrv</a></td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indeces of rvc in common rv. <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de3bd289a26d5549dcf1ed19e5b13569"></a><!-- doxytag: member="compositepdf::rvinrvcs" ref="de3bd289a26d5549dcf1ed19e5b13569" args="" -->
79Array&lt; ivec &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcompositepdf.html#de3bd289a26d5549dcf1ed19e5b13569">rvinrvcs</a></td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Indeces of common rv in rvc. <br></td></tr>
82</table>
83<hr><a name="_details"></a><h2>Detailed Description</h2>
84Abstract composition of pdfs, a base for specific classes. <hr><h2>Member Function Documentation</h2>
85<a class="anchor" name="635d219fb3e32852400d6f98aa4bdc93"></a><!-- doxytag: member="compositepdf::getrv" ref="635d219fb3e32852400d6f98aa4bdc93" args="(bool checkoverlap=false)" -->
86<div class="memitem">
87<div class="memproto">
88      <table class="memname">
89        <tr>
90          <td class="memname"><a class="el" href="classRV.html">RV</a> compositepdf::getrv           </td>
91          <td>(</td>
92          <td class="paramtype">bool&nbsp;</td>
93          <td class="paramname"> <em>checkoverlap</em> = <code>false</code>          </td>
94          <td>&nbsp;)&nbsp;</td>
95          <td></td>
96        </tr>
97      </table>
98</div>
99<div class="memdoc">
100
101<p>
102find common rv, flag
103<p>
104<dl compact><dt><b>Parameters:</b></dt><dd>
105  <table border="0" cellspacing="2" cellpadding="0">
106    <tr><td valign="top"></td><td valign="top"><em>checkoverlap</em>&nbsp;</td><td>modifies whether overlaps are acceptable </td></tr>
107  </table>
108</dl>
109
110<p>References <a class="el" href="libBM_8cpp-source.html#l00051">RV::add()</a>, <a class="el" href="libBM_8h-source.html#l00258">mpdfs</a>, and <a class="el" href="libBM_8h-source.html#l00256">n</a>.</p>
111
112</div>
113</div><p>
114<hr>The documentation for this class was generated from the following files:<ul>
115<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>
116</div>
117<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 15 15:57:12 2008 for mixpp by&nbsp;
118<a href="http://www.doxygen.org/index.html">
119<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
120</body>
121</html>
Note: See TracBrowser for help on using the browser.