root/doc/html/classRV.html @ 99

Revision 99, 14.7 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: 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.5 -->
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="e032d2e90e5b6e156d15f137caca940f"></a><!-- doxytag: member="RV::RV" ref="e032d2e90e5b6e156d15f137caca940f" args="(ivec in_ids, 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#e032d2e90e5b6e156d15f137caca940f">RV</a> (ivec in_ids, 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 which is called by the others. <br></td></tr>
40<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf911c3900214460ade1366b04058462"></a><!-- doxytag: member="RV::RV" ref="cf911c3900214460ade1366b04058462" args="(ivec ids)" -->
41&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#cf911c3900214460ade1366b04058462">RV</a> (ivec <a class="el" href="classRV.html#1bd7165140f4b880a7f344bbb1c433f9">ids</a>)</td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">default constructor <br></td></tr>
44<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6a22f5c06d6403870d4e414b1993bf9e"></a><!-- doxytag: member="RV::RV" ref="6a22f5c06d6403870d4e414b1993bf9e" args="()" -->
45&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#6a22f5c06d6403870d4e414b1993bf9e">RV</a> ()</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Empty constructor will be set later. <br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f5c7b8bd589eef09ccdf3329a0addea0"></a><!-- doxytag: member="RV::count" ref="f5c7b8bd589eef09ccdf3329a0addea0" args="() const " -->
49int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#f5c7b8bd589eef09ccdf3329a0addea0">count</a> () const </td></tr>
50
51<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>
52<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c114a6f3ff06796cc2f4dacba74291eb"></a><!-- doxytag: member="RV::length" ref="c114a6f3ff06796cc2f4dacba74291eb" args="() const " -->
53int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#c114a6f3ff06796cc2f4dacba74291eb">length</a> () const </td></tr>
54
55<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>
56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6b078b1086224aca3a9e5a203e647fb6"></a><!-- doxytag: member="RV::find" ref="6b078b1086224aca3a9e5a203e647fb6" args="(RV rv2)" -->
57ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#6b078b1086224aca3a9e5a203e647fb6">find</a> (<a class="el" href="classRV.html">RV</a> rv2)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find indexes of another rv in self. <br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4fc941a5ebc9f82aa372f54f2e02dab2"></a><!-- doxytag: member="RV::add" ref="4fc941a5ebc9f82aa372f54f2e02dab2" args="(const RV &amp;rv2)" -->
61void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#4fc941a5ebc9f82aa372f54f2e02dab2">add</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv2)</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add (concat) another variable to the current one. <br></td></tr>
64<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c5ec5e913fc598e242cb930ae8bdf4a"></a><!-- doxytag: member="RV::subt" ref="4c5ec5e913fc598e242cb930ae8bdf4a" args="(RV rv2)" -->
65<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#4c5ec5e913fc598e242cb930ae8bdf4a">subt</a> (<a class="el" href="classRV.html">RV</a> rv2)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Subtract another variable from the current one. <br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2bf35b18a32aad419f0516273939628e"></a><!-- doxytag: member="RV::subselect" ref="2bf35b18a32aad419f0516273939628e" args="(ivec ind)" -->
69<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#2bf35b18a32aad419f0516273939628e">subselect</a> (ivec ind)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indeces ind. <br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="28bbcb8873bafdac317bafb7b481cc45"></a><!-- doxytag: member="RV::operator()" ref="28bbcb8873bafdac317bafb7b481cc45" args="(ivec ind)" -->
73<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#28bbcb8873bafdac317bafb7b481cc45">operator()</a> (ivec ind)</td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Select only variables at indeces ind. <br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e0a158d53ab9430627241f844f4c9a60"></a><!-- doxytag: member="RV::t" ref="e0a158d53ab9430627241f844f4c9a60" args="(int delta)" -->
77void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#e0a158d53ab9430627241f844f4c9a60">t</a> (int delta)</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generate new <code><a class="el" href="classRV.html" title="Class representing variables, most often random variables.">RV</a></code> with <code>time</code> shifted by delta. <br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8470cf53be6e7bdba78ad0efbd203ee7"></a><!-- doxytag: member="RV::indexlist" ref="8470cf53be6e7bdba78ad0efbd203ee7" args="()" -->
81ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#8470cf53be6e7bdba78ad0efbd203ee7">indexlist</a> ()</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">generate a list of indeces, i.e. which <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b88ef5124713c9e30fd9446846b3f044"></a><!-- doxytag: member="RV::_names" ref="b88ef5124713c9e30fd9446846b3f044" args="()" -->
85Array&lt; std::string &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#b88ef5124713c9e30fd9446846b3f044">_names</a> ()</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4a0069bc69f5a98d7ce9ed59077f2e6c"></a><!-- doxytag: member="RV::id" ref="4a0069bc69f5a98d7ce9ed59077f2e6c" args="(int at)" -->
89int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#4a0069bc69f5a98d7ce9ed59077f2e6c">id</a> (int at)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="20db23a5585d64a6e24404cc8379bc28"></a><!-- doxytag: member="RV::size" ref="20db23a5585d64a6e24404cc8379bc28" args="(int at)" -->
93int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#20db23a5585d64a6e24404cc8379bc28">size</a> (int at)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af068cf478864fe1a4fbfc6b4693b088"></a><!-- doxytag: member="RV::time" ref="af068cf478864fe1a4fbfc6b4693b088" args="(int at)" -->
97int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#af068cf478864fe1a4fbfc6b4693b088">time</a> (int at)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ae4dd6e368f814a02710636ac8e1721"></a><!-- doxytag: member="RV::name" ref="3ae4dd6e368f814a02710636ac8e1721" args="(int at)" -->
101std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#3ae4dd6e368f814a02710636ac8e1721">name</a> (int at)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">access function <br></td></tr>
104<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2396efe2e6d656ebe9e6f06018cbe25"></a><!-- doxytag: member="RV::tsize" ref="f2396efe2e6d656ebe9e6f06018cbe25" args="" -->
106int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#f2396efe2e6d656ebe9e6f06018cbe25">tsize</a></td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size = sum of sizes <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0d7b36e2bbccf880c8fcf1e8cc43c1a9"></a><!-- doxytag: member="RV::len" ref="0d7b36e2bbccf880c8fcf1e8cc43c1a9" args="" -->
110int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#0d7b36e2bbccf880c8fcf1e8cc43c1a9">len</a></td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">len = number of individual rvs <br></td></tr>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1bd7165140f4b880a7f344bbb1c433f9"></a><!-- doxytag: member="RV::ids" ref="1bd7165140f4b880a7f344bbb1c433f9" args="" -->
114ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#1bd7165140f4b880a7f344bbb1c433f9">ids</a></td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector of unique IDs. <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c878aab13f34b420e1eb5b485563682b"></a><!-- doxytag: member="RV::sizes" ref="c878aab13f34b420e1eb5b485563682b" args="" -->
118ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#c878aab13f34b420e1eb5b485563682b">sizes</a></td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector of sizes. <br></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="646e530c47a2dd38254b778d9f11ac89"></a><!-- doxytag: member="RV::times" ref="646e530c47a2dd38254b778d9f11ac89" args="" -->
122ivec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#646e530c47a2dd38254b778d9f11ac89">times</a></td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector of shifts from current time. <br></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="df5d0030b277a1db2f1fd5fb79152acb"></a><!-- doxytag: member="RV::names" ref="df5d0030b277a1db2f1fd5fb79152acb" args="" -->
126Array&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#df5d0030b277a1db2f1fd5fb79152acb">names</a></td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array of names. <br></td></tr>
129<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
130<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)" -->
131std::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>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Printing output e.g. for debugging. <br></td></tr>
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="33c114e83980d883c5b211c47d5322a4"></a><!-- doxytag: member="RV::concat" ref="33c114e83980d883c5b211c47d5322a4" args="(const RV &amp;rv1, const RV &amp;rv2)" -->
135<a class="el" href="classRV.html">RV</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRV.html#33c114e83980d883c5b211c47d5322a4">concat</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv1, const <a class="el" href="classRV.html">RV</a> &amp;rv2)</td></tr>
136
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add (concat) another variable to the current one. <br></td></tr>
138</table>
139<hr><a name="_details"></a><h2>Detailed Description</h2>
140Class representing variables, most often random variables.
141<p>
142More?... <hr>The documentation for this class was generated from the following files:<ul>
143<li>work/mixpp/bdm/stat/<a class="el" href="libBM_8h-source.html">libBM.h</a><li>work/mixpp/bdm/stat/libBM.cpp</ul>
144</div>
145<hr size="1"><address style="text-align: right;"><small>Generated on Fri May 9 16:15:28 2008 for mixpp by&nbsp;
146<a href="http://www.doxygen.org/index.html">
147<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
148</body>
149</html>
Note: See TracBrowser for help on using the browser.