root/doc/xml/classeuni.xml @ 234

Revision 187, 20.5 kB (checked in by smidl, 16 years ago)

doc

Line 
1<?xml version='1.0' encoding='UTF-8' standalone='no'?>
2<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.5.6">
3  <compounddef id="classeuni" kind="class" prot="public">
4    <compoundname>euni</compoundname>
5    <basecompoundref refid="classepdf" prot="public" virt="non-virtual">epdf</basecompoundref>
6    <includes refid="libEF_8h" local="no">libEF.h</includes>
7      <sectiondef kind="protected-attrib">
8      <memberdef kind="variable" id="classeuni_1ef42cd8d7645422048d46c46ec5cdac1" prot="protected" static="no" mutable="no">
9        <type>vec</type>
10        <definition>vec euni::low</definition>
11        <argsstring></argsstring>
12        <name>low</name>
13        <briefdescription>
14<para>lower bound on support </para>        </briefdescription>
15        <detaileddescription>
16        </detaileddescription>
17        <inbodydescription>
18        </inbodydescription>
19        <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="192" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="192" bodyend="-1"/>
20        <referencedby refid="classeuni_18050087e421a9cfd1b4b1f8bd33b1cc1" compoundref="libEF_8h" startline="221" endline="221">mean</referencedby>
21        <referencedby refid="classeuni_14a0e09392be17beaee120ba98fc038cd" compoundref="libEF_8h" startline="206" endline="211">sample</referencedby>
22        <referencedby refid="classeuni_14fd7c6a05100616ad16ece405cad7bf2" compoundref="libEF_8h" startline="213" endline="220">set_parameters</referencedby>
23      </memberdef>
24      <memberdef kind="variable" id="classeuni_171b6d6b41aeb61a7f76f682b72119231" prot="protected" static="no" mutable="no">
25        <type>vec</type>
26        <definition>vec euni::high</definition>
27        <argsstring></argsstring>
28        <name>high</name>
29        <briefdescription>
30<para>upper bound on support </para>        </briefdescription>
31        <detaileddescription>
32        </detaileddescription>
33        <inbodydescription>
34        </inbodydescription>
35        <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="194" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="194" bodyend="-1"/>
36        <referencedby refid="classeuni_18050087e421a9cfd1b4b1f8bd33b1cc1" compoundref="libEF_8h" startline="221" endline="221">mean</referencedby>
37        <referencedby refid="classeuni_14fd7c6a05100616ad16ece405cad7bf2" compoundref="libEF_8h" startline="213" endline="220">set_parameters</referencedby>
38      </memberdef>
39      <memberdef kind="variable" id="classeuni_152a6ff4a54010f88a6a19fca605c64a4" prot="protected" static="no" mutable="no">
40        <type>vec</type>
41        <definition>vec euni::distance</definition>
42        <argsstring></argsstring>
43        <name>distance</name>
44        <briefdescription>
45<para>internal </para>        </briefdescription>
46        <detaileddescription>
47        </detaileddescription>
48        <inbodydescription>
49        </inbodydescription>
50        <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="196" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="196" bodyend="-1"/>
51        <referencedby refid="classeuni_14a0e09392be17beaee120ba98fc038cd" compoundref="libEF_8h" startline="206" endline="211">sample</referencedby>
52        <referencedby refid="classeuni_14fd7c6a05100616ad16ece405cad7bf2" compoundref="libEF_8h" startline="213" endline="220">set_parameters</referencedby>
53      </memberdef>
54      <memberdef kind="variable" id="classeuni_163105490e946e43372d6187ad1bafdda" prot="protected" static="no" mutable="no">
55        <type>double</type>
56        <definition>double euni::nk</definition>
57        <argsstring></argsstring>
58        <name>nk</name>
59        <briefdescription>
60<para>normalizing coefficients </para>        </briefdescription>
61        <detaileddescription>
62        </detaileddescription>
63        <inbodydescription>
64        </inbodydescription>
65        <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="198" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="198" bodyend="-1"/>
66        <referencedby refid="classeuni_12723d4992900b5c5495bfa03628195ed" compoundref="libEF_8h" startline="204" endline="204">eval</referencedby>
67        <referencedby refid="classeuni_14fd7c6a05100616ad16ece405cad7bf2" compoundref="libEF_8h" startline="213" endline="220">set_parameters</referencedby>
68      </memberdef>
69      <memberdef kind="variable" id="classeuni_1f445a0ce24f39d14c1a4eed53fc8e2c3" prot="protected" static="no" mutable="no">
70        <type>double</type>
71        <definition>double euni::lnk</definition>
72        <argsstring></argsstring>
73        <name>lnk</name>
74        <briefdescription>
75<para>cache of log( <computeroutput>nk</computeroutput> ) </para>        </briefdescription>
76        <detaileddescription>
77        </detaileddescription>
78        <inbodydescription>
79        </inbodydescription>
80        <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="200" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="200" bodyend="-1"/>
81        <referencedby refid="classeuni_106af95d514a6623ad4688bd2ad50ad71" compoundref="libEF_8h" startline="205" endline="205">evalpdflog</referencedby>
82        <referencedby refid="classeuni_14fd7c6a05100616ad16ece405cad7bf2" compoundref="libEF_8h" startline="213" endline="220">set_parameters</referencedby>
83      </memberdef>
84      <memberdef kind="variable" id="classepdf_174da992e3f5d598da8850b646b79b9d9" prot="protected" static="no" mutable="no">
85        <type><ref refid="classRV" kindref="compound">RV</ref></type>
86        <definition>RV epdf::rv</definition>
87        <argsstring></argsstring>
88        <name>rv</name>
89        <briefdescription>
90<para>Identified of the random variable. </para>        </briefdescription>
91        <detaileddescription>
92        </detaileddescription>
93        <inbodydescription>
94        </inbodydescription>
95        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="138" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="138" bodyend="-1"/>
96        <referencedby refid="classepdf_14778ea61ef400813e47750e024e9fc2f" compoundref="libBM_8h" startline="164" endline="164">epdf::_rv</referencedby>
97        <referencedby refid="classegamma_1de84faac8f9799dfe2777ddbedf997ef" compoundref="libEF_8cpp" startline="83" endline="92">egamma::evalpdflog</referencedby>
98        <referencedby refid="classegiw_1425cbc53b377274e28c6add942bab62d" compoundref="libEF_8cpp" startline="19" endline="29">egiw::evalpdflog</referencedby>
99        <referencedby refid="classegamma_1d6dbbdb72360f9e54d64501f80318bb6" compoundref="libEF_8cpp" startline="94" endline="103">egamma::lognc</referencedby>
100        <referencedby refid="classeEmp_1ba055c19038cc72628d98e25197e982d" compoundref="libEF_8h" startline="334" endline="338">eEmp::mean</referencedby>
101        <referencedby refid="classemix_1b662a51d042b062020460e64bff4e9e8" compoundref="emix_8h" startline="45" endline="49">emix::mean</referencedby>
102        <referencedby refid="classeuni_14a0e09392be17beaee120ba98fc038cd" compoundref="libEF_8h" startline="206" endline="211">sample</referencedby>
103        <referencedby refid="classegamma_18e10c0021b5dfdd9cb62c6959b5ef425" compoundref="libEF_8cpp" startline="55" endline="66">egamma::sample</referencedby>
104        <referencedby refid="classepdf_154d7dd53a641b618771cd9bee135181f" compoundref="libBM_8cpp" startline="113" endline="117">epdf::sampleN</referencedby>
105        <referencedby refid="classemix_16ce82b24d7fe540ddbf44b472a005555" compoundref="emix_8cpp" startline="5" endline="12">emix::set_parameters</referencedby>
106      </memberdef>
107      </sectiondef>
108      <sectiondef kind="public-func">
109      <memberdef kind="function" id="classeuni_12537a6c239cff52e3ba814851a1116cd" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
110        <type></type>
111        <definition>euni::euni</definition>
112        <argsstring>(const RV rv)</argsstring>
113        <name>euni</name>
114        <param>
115          <type>const <ref refid="classRV" kindref="compound">RV</ref></type>
116          <declname>rv</declname>
117        </param>
118        <briefdescription>
119<para>Defualt constructor. </para>        </briefdescription>
120        <detaileddescription>
121        </detaileddescription>
122        <inbodydescription>
123        </inbodydescription>
124        <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="203" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="203" bodyend="203"/>
125      </memberdef>
126      <memberdef kind="function" id="classeuni_12723d4992900b5c5495bfa03628195ed" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
127        <type>double</type>
128        <definition>double euni::eval</definition>
129        <argsstring>(const vec &amp;val) const </argsstring>
130        <name>eval</name>
131        <reimplements refid="classepdf_13ea597362e11a0040fe7c990269d072c">eval</reimplements>
132        <param>
133          <type>const vec &amp;</type>
134          <declname>val</declname>
135        </param>
136        <briefdescription>
137<para>Compute probability of argument <computeroutput>val</computeroutput>. </para>        </briefdescription>
138        <detaileddescription>
139        </detaileddescription>
140        <inbodydescription>
141        </inbodydescription>
142        <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="204" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="204" bodyend="204"/>
143        <references refid="classeuni_163105490e946e43372d6187ad1bafdda" compoundref="libEF_8h" startline="198">nk</references>
144      </memberdef>
145      <memberdef kind="function" id="classeuni_106af95d514a6623ad4688bd2ad50ad71" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
146        <type>double</type>
147        <definition>double euni::evalpdflog</definition>
148        <argsstring>(const vec &amp;val) const </argsstring>
149        <name>evalpdflog</name>
150        <reimplements refid="classepdf_16aef3eca74899692503769c18add1a4c">evalpdflog</reimplements>
151        <param>
152          <type>const vec &amp;</type>
153          <declname>val</declname>
154        </param>
155        <briefdescription>
156<para>Compute log-probability of argument <computeroutput>val</computeroutput>. </para>        </briefdescription>
157        <detaileddescription>
158        </detaileddescription>
159        <inbodydescription>
160        </inbodydescription>
161        <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="205" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="205" bodyend="205"/>
162        <references refid="classeuni_1f445a0ce24f39d14c1a4eed53fc8e2c3" compoundref="libEF_8h" startline="200">lnk</references>
163      </memberdef>
164      <memberdef kind="function" id="classeuni_14a0e09392be17beaee120ba98fc038cd" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
165        <type>vec</type>
166        <definition>vec euni::sample</definition>
167        <argsstring>() const </argsstring>
168        <name>sample</name>
169        <reimplements refid="classepdf_18019654e494bf5e458f6fb947e11b262">sample</reimplements>
170        <briefdescription>
171<para>Returns the required moment of the <ref refid="classepdf" kindref="compound">epdf</ref>. </para>        </briefdescription>
172        <detaileddescription>
173<para>Returns a sample, <formula id="28">$x$</formula> from density <formula id="59">$epdf(rv)$</formula> </para>        </detaileddescription>
174        <inbodydescription>
175        </inbodydescription>
176        <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="206" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="206" bodyend="211"/>
177        <references refid="classRV_1f5c7b8bd589eef09ccdf3329a0addea0" compoundref="libBM_8h" startline="69" endline="69">RV::count</references>
178        <references refid="classeuni_152a6ff4a54010f88a6a19fca605c64a4" compoundref="libEF_8h" startline="196">distance</references>
179        <references refid="classeuni_1ef42cd8d7645422048d46c46ec5cdac1" compoundref="libEF_8h" startline="192">low</references>
180        <references refid="classepdf_174da992e3f5d598da8850b646b79b9d9" compoundref="libBM_8h" startline="138">epdf::rv</references>
181      </memberdef>
182      <memberdef kind="function" id="classeuni_14fd7c6a05100616ad16ece405cad7bf2" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
183        <type>void</type>
184        <definition>void euni::set_parameters</definition>
185        <argsstring>(const vec &amp;low0, const vec &amp;high0)</argsstring>
186        <name>set_parameters</name>
187        <param>
188          <type>const vec &amp;</type>
189          <declname>low0</declname>
190        </param>
191        <param>
192          <type>const vec &amp;</type>
193          <declname>high0</declname>
194        </param>
195        <briefdescription>
196<para>set values of <computeroutput>low</computeroutput> and <computeroutput>high</computeroutput> </para>        </briefdescription>
197        <detaileddescription>
198        </detaileddescription>
199        <inbodydescription>
200        </inbodydescription>
201        <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="213" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="213" bodyend="220"/>
202        <references refid="classeuni_152a6ff4a54010f88a6a19fca605c64a4" compoundref="libEF_8h" startline="196">distance</references>
203        <references refid="classeuni_171b6d6b41aeb61a7f76f682b72119231" compoundref="libEF_8h" startline="194">high</references>
204        <references refid="classeuni_1f445a0ce24f39d14c1a4eed53fc8e2c3" compoundref="libEF_8h" startline="200">lnk</references>
205        <references refid="classeuni_1ef42cd8d7645422048d46c46ec5cdac1" compoundref="libEF_8h" startline="192">low</references>
206        <references refid="classeuni_163105490e946e43372d6187ad1bafdda" compoundref="libEF_8h" startline="198">nk</references>
207      </memberdef>
208      <memberdef kind="function" id="classeuni_18050087e421a9cfd1b4b1f8bd33b1cc1" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
209        <type>vec</type>
210        <definition>vec euni::mean</definition>
211        <argsstring>() const </argsstring>
212        <name>mean</name>
213        <reimplements refid="classepdf_1bf0a070a8f3e67a93604ca724638b870">mean</reimplements>
214        <briefdescription>
215<para>return expected value </para>        </briefdescription>
216        <detaileddescription>
217        </detaileddescription>
218        <inbodydescription>
219        </inbodydescription>
220        <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="221" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="221" bodyend="221"/>
221        <references refid="classeuni_171b6d6b41aeb61a7f76f682b72119231" compoundref="libEF_8h" startline="194">high</references>
222        <references refid="classeuni_1ef42cd8d7645422048d46c46ec5cdac1" compoundref="libEF_8h" startline="192">low</references>
223      </memberdef>
224      <memberdef kind="function" id="classepdf_154d7dd53a641b618771cd9bee135181f" prot="public" static="no" const="yes" explicit="no" inline="no" virt="virtual">
225        <type>mat</type>
226        <definition>mat epdf::sampleN</definition>
227        <argsstring>(int N) const </argsstring>
228        <name>sampleN</name>
229        <param>
230          <type>int</type>
231          <declname>N</declname>
232        </param>
233        <briefdescription>
234<para>Returns N samples from density <formula id="59">$epdf(rv)$</formula>. </para>        </briefdescription>
235        <detaileddescription>
236        </detaileddescription>
237        <inbodydescription>
238        </inbodydescription>
239        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="151" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.cpp" bodystart="113" bodyend="117"/>
240        <references refid="classRV_1f5c7b8bd589eef09ccdf3329a0addea0" compoundref="libBM_8h" startline="69" endline="69">RV::count</references>
241        <references refid="classepdf_174da992e3f5d598da8850b646b79b9d9" compoundref="libBM_8h" startline="138">epdf::rv</references>
242      </memberdef>
243      <memberdef kind="function" id="classepdf_14778ea61ef400813e47750e024e9fc2f" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
244        <type><ref refid="classRV" kindref="compound">RV</ref> &amp;</type>
245        <definition>RV&amp; epdf::_rv</definition>
246        <argsstring>()</argsstring>
247        <name>_rv</name>
248        <briefdescription>
249<para>access function, possibly dangerous! </para>        </briefdescription>
250        <detaileddescription>
251        </detaileddescription>
252        <inbodydescription>
253        </inbodydescription>
254        <location file="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" line="164" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libBM.h" bodystart="164" bodyend="164"/>
255        <references refid="classepdf_174da992e3f5d598da8850b646b79b9d9" compoundref="libBM_8h" startline="138">epdf::rv</references>
256        <referencedby refid="classemix_16ce82b24d7fe540ddbf44b472a005555" compoundref="emix_8cpp" startline="5" endline="12">emix::set_parameters</referencedby>
257      </memberdef>
258      </sectiondef>
259    <briefdescription>
260<para>Uniform distributed density on a rectangular support. </para>    </briefdescription>
261    <detaileddescription>
262    </detaileddescription>
263    <inheritancegraph>
264      <node id="1026">
265        <label>epdf</label>
266        <link refid="classepdf"/>
267      </node>
268      <node id="1025">
269        <label>euni</label>
270        <link refid="classeuni"/>
271        <childnode refid="1026" relation="public-inheritance">
272        </childnode>
273      </node>
274    </inheritancegraph>
275    <collaborationgraph>
276      <node id="1028">
277        <label>epdf</label>
278        <link refid="classepdf"/>
279        <childnode refid="1029" relation="usage">
280          <edgelabel>rv</edgelabel>
281        </childnode>
282      </node>
283      <node id="1029">
284        <label>RV</label>
285        <link refid="classRV"/>
286      </node>
287      <node id="1027">
288        <label>euni</label>
289        <link refid="classeuni"/>
290        <childnode refid="1028" relation="public-inheritance">
291        </childnode>
292      </node>
293    </collaborationgraph>
294    <location file="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" line="189" bodyfile="/home/smidl/work/git/mixpp/bdm/stat/libEF.h" bodystart="189" bodyend="222"/>
295    <listofallmembers>
296      <member refid="classepdf_14778ea61ef400813e47750e024e9fc2f" prot="public" virt="non-virtual"><scope>euni</scope><name>_rv</name></member>
297      <member refid="classeuni_152a6ff4a54010f88a6a19fca605c64a4" prot="protected" virt="non-virtual"><scope>euni</scope><name>distance</name></member>
298      <member refid="classepdf_1d8eb760037b3bad5a0d64081606697cd" prot="public" virt="non-virtual"><scope>euni</scope><name>epdf</name></member>
299      <member refid="classepdf_1c95b1a27a8dd9507bb9a5a3cb2809c7a" prot="public" virt="non-virtual"><scope>euni</scope><name>epdf</name></member>
300      <member refid="classeuni_12537a6c239cff52e3ba814851a1116cd" prot="public" virt="non-virtual"><scope>euni</scope><name>euni</name></member>
301      <member refid="classeuni_12723d4992900b5c5495bfa03628195ed" prot="public" virt="virtual"><scope>euni</scope><name>eval</name></member>
302      <member refid="classeuni_106af95d514a6623ad4688bd2ad50ad71" prot="public" virt="virtual"><scope>euni</scope><name>evalpdflog</name></member>
303      <member refid="classeuni_171b6d6b41aeb61a7f76f682b72119231" prot="protected" virt="non-virtual"><scope>euni</scope><name>high</name></member>
304      <member refid="classeuni_1f445a0ce24f39d14c1a4eed53fc8e2c3" prot="protected" virt="non-virtual"><scope>euni</scope><name>lnk</name></member>
305      <member refid="classeuni_1ef42cd8d7645422048d46c46ec5cdac1" prot="protected" virt="non-virtual"><scope>euni</scope><name>low</name></member>
306      <member refid="classeuni_18050087e421a9cfd1b4b1f8bd33b1cc1" prot="public" virt="virtual"><scope>euni</scope><name>mean</name></member>
307      <member refid="classeuni_163105490e946e43372d6187ad1bafdda" prot="protected" virt="non-virtual"><scope>euni</scope><name>nk</name></member>
308      <member refid="classepdf_174da992e3f5d598da8850b646b79b9d9" prot="protected" virt="non-virtual"><scope>euni</scope><name>rv</name></member>
309      <member refid="classeuni_14a0e09392be17beaee120ba98fc038cd" prot="public" virt="virtual"><scope>euni</scope><name>sample</name></member>
310      <member refid="classepdf_154d7dd53a641b618771cd9bee135181f" prot="public" virt="virtual"><scope>euni</scope><name>sampleN</name></member>
311      <member refid="classeuni_14fd7c6a05100616ad16ece405cad7bf2" prot="public" virt="non-virtual"><scope>euni</scope><name>set_parameters</name></member>
312      <member refid="classepdf_10a322dd106f04c0a2915e3d4f4227396" prot="public" virt="virtual"><scope>euni</scope><name>~epdf</name></member>
313    </listofallmembers>
314  </compounddef>
315</doxygen>
Note: See TracBrowser for help on using the browser.