root/doc/html/classRV.html @ 168

Revision 162, 19.5 kB (checked in by smidl, 16 years ago)

opravy a dokumentace

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: RV 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>RV Class Reference</h1><!-- doxytag: class="RV" -->Class representing variables, most often random variables. 
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
32<p>
33<a href="classRV-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
34<tr><td></td></tr>
35<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
36<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bedfd8d197f0a7ac28a4d412dfc5b8af"></a><!-- doxytag: member="RV::RV" ref="bedfd8d197f0a7ac28a4d412dfc5b8af" args="(Array&lt; std::string &gt; in_names, ivec in_sizes, ivec in_times)" -->
37&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#bedfd8d197f0a7ac28a4d412dfc5b8af">RV</a> (Array&lt; std::string &gt; in_names, ivec in_sizes, ivec in_times)</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Full constructor. <br></td></tr>
40<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b88a74204fdf044e02f2807769839b7"></a><!-- doxytag: member="RV::RV" ref="7b88a74204fdf044e02f2807769839b7" args="(Array&lt; std::string &gt; in_names, ivec in_sizes)" -->
41&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#7b88a74204fdf044e02f2807769839b7">RV</a> (Array&lt; std::string &gt; in_names, ivec in_sizes)</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with times=0. <br></td></tr>
44<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="261702f85831392d7d67e2bcf0b69960"></a><!-- doxytag: member="RV::RV" ref="261702f85831392d7d67e2bcf0b69960" args="(Array&lt; std::string &gt; in_names)" -->
45&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#261702f85831392d7d67e2bcf0b69960">RV</a> (Array&lt; std::string &gt; in_names)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor with sizes=1, times=0. <br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6a22f5c06d6403870d4e414b1993bf9e"></a><!-- doxytag: member="RV::RV" ref="6a22f5c06d6403870d4e414b1993bf9e" args="()" -->
49&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#6a22f5c06d6403870d4e414b1993bf9e">RV</a> ()</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor of empty <a class="el" href="classRV.html" title="Class representing variables, most often random variables.">RV</a>. <br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f5c7b8bd589eef09ccdf3329a0addea0"></a><!-- doxytag: member="RV::count" ref="f5c7b8bd589eef09ccdf3329a0addea0" args="() const " -->
53int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#f5c7b8bd589eef09ccdf3329a0addea0">count</a> () const </td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return number of scalars in the <a class="el" href="classRV.html" title="Class representing variables, most often random variables.">RV</a>. <br></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c114a6f3ff06796cc2f4dacba74291eb"></a><!-- doxytag: member="RV::length" ref="c114a6f3ff06796cc2f4dacba74291eb" args="() const " -->
57int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#c114a6f3ff06796cc2f4dacba74291eb">length</a> () const </td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return length (number of entries) of the <a class="el" href="classRV.html" title="Class representing variables, most often random variables.">RV</a>. <br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top">ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#0c493a7a897f4d75682f4264e40779a1">findself</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv2) const </td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find indexes of self in another rv,.  <a href="#0c493a7a897f4d75682f4264e40779a1"></a><br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="82cc7fa22ce91cf461a522ad62014c65"></a><!-- doxytag: member="RV::equal" ref="82cc7fa22ce91cf461a522ad62014c65" args="(const RV &amp;rv2) const " -->
64bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#82cc7fa22ce91cf461a522ad62014c65">equal</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv2) const </td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compare if <code>rv2</code> is identical to this <code><a class="el" href="classRV.html" title="Class representing variables, most often random variables.">RV</a></code>. <br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#935790526b630dec4ffefa9ec0c2b6fb">add</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv2)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add (concat) another variable to the current one,.  <a href="#935790526b630dec4ffefa9ec0c2b6fb"></a><br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a85c47bd838ebbdcb6798d7843e87db2"></a><!-- doxytag: member="RV::subt" ref="a85c47bd838ebbdcb6798d7843e87db2" args="(const RV rv2) const " -->
71<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#a85c47bd838ebbdcb6798d7843e87db2">subt</a> (const <a class="el" href="classRV.html">RV</a> rv2) const </td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Subtract another variable from the current one. <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a9ea7bc6fad270cc54a455a9f8f387d"></a><!-- doxytag: member="RV::subselect" ref="0a9ea7bc6fad270cc54a455a9f8f387d" args="(ivec ind) const " -->
75<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#0a9ea7bc6fad270cc54a455a9f8f387d">subselect</a> (ivec ind) const </td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indeces ind. <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65e5b820e482caff7f284d11898ef64f"></a><!-- doxytag: member="RV::operator()" ref="65e5b820e482caff7f284d11898ef64f" args="(ivec ind) const " -->
79<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#65e5b820e482caff7f284d11898ef64f">operator()</a> (ivec ind) const </td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indeces ind. <br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0a158d53ab9430627241f844f4c9a60"></a><!-- doxytag: member="RV::t" ref="e0a158d53ab9430627241f844f4c9a60" args="(int delta)" -->
83void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#e0a158d53ab9430627241f844f4c9a60">t</a> (int delta)</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shift <code>time</code> shifted by delta. <br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52f3ade796814da627ff5a44d00986be"></a><!-- doxytag: member="RV::tostr" ref="52f3ade796814da627ff5a44d00986be" args="() const " -->
87<a class="el" href="classstr.html">str</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#52f3ade796814da627ff5a44d00986be">tostr</a> () const </td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">generate <code><a class="el" href="classstr.html" title="Structure of RV (used internally).">str</a></code> from rv, by expanding sizes <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top">ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#1844ea0d9c10428f5e0ee1d4d569ef0a">dataind</a> (<a class="el" href="classRV.html">RV</a> crv) const </td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">generate indeces into  <a href="#1844ea0d9c10428f5e0ee1d4d569ef0a"></a><br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b88ef5124713c9e30fd9446846b3f044"></a><!-- doxytag: member="RV::_names" ref="b88ef5124713c9e30fd9446846b3f044" args="()" -->
94Array&lt; std::string &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#b88ef5124713c9e30fd9446846b3f044">_names</a> ()</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4a0069bc69f5a98d7ce9ed59077f2e6c"></a><!-- doxytag: member="RV::id" ref="4a0069bc69f5a98d7ce9ed59077f2e6c" args="(int at)" -->
98int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#4a0069bc69f5a98d7ce9ed59077f2e6c">id</a> (int at)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="20db23a5585d64a6e24404cc8379bc28"></a><!-- doxytag: member="RV::size" ref="20db23a5585d64a6e24404cc8379bc28" args="(int at)" -->
102int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#20db23a5585d64a6e24404cc8379bc28">size</a> (int at)</td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af068cf478864fe1a4fbfc6b4693b088"></a><!-- doxytag: member="RV::time" ref="af068cf478864fe1a4fbfc6b4693b088" args="(int at)" -->
106int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#af068cf478864fe1a4fbfc6b4693b088">time</a> (int at)</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ae4dd6e368f814a02710636ac8e1721"></a><!-- doxytag: member="RV::name" ref="3ae4dd6e368f814a02710636ac8e1721" args="(int at)" -->
110std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#3ae4dd6e368f814a02710636ac8e1721">name</a> (int at)</td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
113<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2396efe2e6d656ebe9e6f06018cbe25"></a><!-- doxytag: member="RV::tsize" ref="f2396efe2e6d656ebe9e6f06018cbe25" args="" -->
115int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#f2396efe2e6d656ebe9e6f06018cbe25">tsize</a></td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size = sum of sizes <br></td></tr>
118<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0d7b36e2bbccf880c8fcf1e8cc43c1a9"></a><!-- doxytag: member="RV::len" ref="0d7b36e2bbccf880c8fcf1e8cc43c1a9" args="" -->
119int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#0d7b36e2bbccf880c8fcf1e8cc43c1a9">len</a></td></tr>
120
121<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">len = number of individual rvs <br></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1bd7165140f4b880a7f344bbb1c433f9"></a><!-- doxytag: member="RV::ids" ref="1bd7165140f4b880a7f344bbb1c433f9" args="" -->
123ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#1bd7165140f4b880a7f344bbb1c433f9">ids</a></td></tr>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector of unique IDs. <br></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c878aab13f34b420e1eb5b485563682b"></a><!-- doxytag: member="RV::sizes" ref="c878aab13f34b420e1eb5b485563682b" args="" -->
127ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#c878aab13f34b420e1eb5b485563682b">sizes</a></td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector of sizes. <br></td></tr>
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="646e530c47a2dd38254b778d9f11ac89"></a><!-- doxytag: member="RV::times" ref="646e530c47a2dd38254b778d9f11ac89" args="" -->
131ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#646e530c47a2dd38254b778d9f11ac89">times</a></td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector of shifts from current time. <br></td></tr>
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="df5d0030b277a1db2f1fd5fb79152acb"></a><!-- doxytag: member="RV::names" ref="df5d0030b277a1db2f1fd5fb79152acb" args="" -->
135Array&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#df5d0030b277a1db2f1fd5fb79152acb">names</a></td></tr>
136
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array of names. <br></td></tr>
138<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cad6f15535d10437f6690cb4492176a8"></a><!-- doxytag: member="RV::operator&lt;&lt;" ref="cad6f15535d10437f6690cb4492176a8" args="(std::ostream &amp;os, const RV &amp;rv)" -->
140std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#cad6f15535d10437f6690cb4492176a8">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classRV.html">RV</a> &amp;rv)</td></tr>
141
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Printing output e.g. for debugging. <br></td></tr>
143</table>
144<hr><a name="_details"></a><h2>Detailed Description</h2>
145Class representing variables, most often random variables.
146<p>
147More?... <hr><h2>Member Function Documentation</h2>
148<a class="anchor" name="0c493a7a897f4d75682f4264e40779a1"></a><!-- doxytag: member="RV::findself" ref="0c493a7a897f4d75682f4264e40779a1" args="(const RV &amp;rv2) const " -->
149<div class="memitem">
150<div class="memproto">
151      <table class="memname">
152        <tr>
153          <td class="memname">ivec RV::findself           </td>
154          <td>(</td>
155          <td class="paramtype">const <a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td>
156          <td class="paramname"> <em>rv2</em>          </td>
157          <td>&nbsp;)&nbsp;</td>
158          <td> const</td>
159        </tr>
160      </table>
161</div>
162<div class="memdoc">
163
164<p>
165Find indexes of self in another rv,.
166<p>
167<dl class="return" compact><dt><b>Returns:</b></dt><dd>ivec of the same size as self. </dd></dl>
168
169<p>References <a class="el" href="libBM_8h-source.html#l00044">ids</a>, <a class="el" href="libBM_8h-source.html#l00042">len</a>, <a class="el" href="libBM_8h-source.html#l00071">length()</a>, and <a class="el" href="libBM_8h-source.html#l00048">times</a>.</p>
170
171<p>Referenced by <a class="el" href="libBM_8cpp-source.html#l00051">add()</a>, and <a class="el" href="libBM_8cpp-source.html#l00154">subt()</a>.</p>
172
173</div>
174</div><p>
175<a class="anchor" name="935790526b630dec4ffefa9ec0c2b6fb"></a><!-- doxytag: member="RV::add" ref="935790526b630dec4ffefa9ec0c2b6fb" args="(const RV &amp;rv2)" -->
176<div class="memitem">
177<div class="memproto">
178      <table class="memname">
179        <tr>
180          <td class="memname">bool RV::add           </td>
181          <td>(</td>
182          <td class="paramtype">const <a class="el" href="classRV.html">RV</a> &amp;&nbsp;</td>
183          <td class="paramname"> <em>rv2</em>          </td>
184          <td>&nbsp;)&nbsp;</td>
185          <td></td>
186        </tr>
187      </table>
188</div>
189<div class="memdoc">
190
191<p>
192Add (concat) another variable to the current one,.
193<p>
194<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if all rv2 were added, 1 if rv2 is in conflict </dd></dl>
195
196<p>References <a class="el" href="libBM_8cpp-source.html#l00163">findself()</a>, <a class="el" href="libBM_8h-source.html#l00044">ids</a>, <a class="el" href="libBM_8h-source.html#l00042">len</a>, <a class="el" href="libBM_8h-source.html#l00050">names</a>, <a class="el" href="libBM_8h-source.html#l00046">sizes</a>, <a class="el" href="libBM_8h-source.html#l00048">times</a>, and <a class="el" href="libBM_8h-source.html#l00040">tsize</a>.</p>
197
198<p>Referenced by <a class="el" href="libBM_8cpp-source.html#l00177">concat()</a>, <a class="el" href="libPF_8h-source.html#l00104">MPF&lt; BM_T &gt;::MPF()</a>, and <a class="el" href="emix_8h-source.html#l00090">mprod::mprod()</a>.</p>
199
200</div>
201</div><p>
202<a class="anchor" name="1844ea0d9c10428f5e0ee1d4d569ef0a"></a><!-- doxytag: member="RV::dataind" ref="1844ea0d9c10428f5e0ee1d4d569ef0a" args="(RV crv) const " -->
203<div class="memitem">
204<div class="memproto">
205      <table class="memname">
206        <tr>
207          <td class="memname">ivec RV::dataind           </td>
208          <td>(</td>
209          <td class="paramtype"><a class="el" href="classRV.html">RV</a>&nbsp;</td>
210          <td class="paramname"> <em>crv</em>          </td>
211          <td>&nbsp;)&nbsp;</td>
212          <td> const</td>
213        </tr>
214      </table>
215</div>
216<div class="memdoc">
217
218<p>
219generate indeces into
220<p>
221<dl compact><dt><b>Parameters:</b></dt><dd>
222  <table border="0" cellspacing="2" cellpadding="0">
223    <tr><td valign="top"></td><td valign="top"><em>crv</em>&nbsp;</td><td>data vector that form data vector of self. </td></tr>
224  </table>
225</dl>
226
227<p>References <a class="el" href="libBM_8h-source.html#l00044">ids</a>, <a class="el" href="libBM_8h-source.html#l00024">str::ids</a>, <a class="el" href="libBM_8h-source.html#l00042">len</a>, <a class="el" href="libBM_8h-source.html#l00048">times</a>, <a class="el" href="libBM_8h-source.html#l00025">str::times</a>, and <a class="el" href="libBM_8cpp-source.html#l00129">tostr()</a>.</p>
228
229</div>
230</div><p>
231<hr>The documentation for this class was generated from the following files:<ul>
232<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>
233</div>
234<hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 4 19:28:13 2008 for mixpp by&nbsp;
235<a href="http://www.doxygen.org/index.html">
236<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
237</body>
238</html>
Note: See TracBrowser for help on using the browser.