root/doc/xml/classitpp_1_1Gamma__RNG.xml @ 187

Revision 187, 13.8 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="classitpp_1_1Gamma__RNG" kind="class" prot="public">
4    <compoundname>itpp::Gamma_RNG</compoundname>
5    <includes refid="itpp__ext_8h" local="no">itpp_ext.h</includes>
6      <sectiondef kind="private-attrib">
7      <memberdef kind="variable" id="classitpp_1_1Gamma__RNG_18f1b44b286dc0f2d2cd604fb44ba5955" prot="private" static="no" mutable="no">
8        <type>double</type>
9        <definition>double itpp::Gamma_RNG::alpha</definition>
10        <argsstring></argsstring>
11        <name>alpha</name>
12        <briefdescription>
13        </briefdescription>
14        <detaileddescription>
15        </detaileddescription>
16        <inbodydescription>
17        </inbodydescription>
18        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="55" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" bodystart="55" bodyend="-1"/>
19      </memberdef>
20      <memberdef kind="variable" id="classitpp_1_1Gamma__RNG_1271318dafa207cb392b1a95a10b271ee" prot="private" static="no" mutable="no">
21        <type>double</type>
22        <definition>double itpp::Gamma_RNG::beta</definition>
23        <argsstring></argsstring>
24        <name>beta</name>
25        <briefdescription>
26        </briefdescription>
27        <detaileddescription>
28        </detaileddescription>
29        <inbodydescription>
30        </inbodydescription>
31        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="57" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" bodystart="57" bodyend="-1"/>
32      </memberdef>
33      <memberdef kind="variable" id="classitpp_1_1Gamma__RNG_11d8015477d8cb406a912dce969a85b60" prot="private" static="no" mutable="no">
34        <type>Random_Generator</type>
35        <definition>Random_Generator itpp::Gamma_RNG::RNG</definition>
36        <argsstring></argsstring>
37        <name>RNG</name>
38        <briefdescription>
39        </briefdescription>
40        <detaileddescription>
41        </detaileddescription>
42        <inbodydescription>
43        </inbodydescription>
44        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="59" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" bodystart="59" bodyend="-1"/>
45      </memberdef>
46      <memberdef kind="variable" id="classitpp_1_1Gamma__RNG_1af4a6b9ab9dd8fad2fe7fe7fa63192c3" prot="private" static="no" mutable="no">
47        <type>Normal_RNG</type>
48        <definition>Normal_RNG itpp::Gamma_RNG::NRNG</definition>
49        <argsstring></argsstring>
50        <name>NRNG</name>
51        <briefdescription>
52        </briefdescription>
53        <detaileddescription>
54        </detaileddescription>
55        <inbodydescription>
56        </inbodydescription>
57        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="60" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" bodystart="60" bodyend="-1"/>
58      </memberdef>
59      </sectiondef>
60      <sectiondef kind="public-func">
61      <memberdef kind="function" id="classitpp_1_1Gamma__RNG_1e132860f825f427d63652edd02c25b54" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
62        <type></type>
63        <definition>itpp::Gamma_RNG::Gamma_RNG</definition>
64        <argsstring>(double a=1.0, double b=1.0)</argsstring>
65        <name>Gamma_RNG</name>
66        <param>
67          <type>double</type>
68          <declname>a</declname>
69          <defval>1.0</defval>
70        </param>
71        <param>
72          <type>double</type>
73          <declname>b</declname>
74          <defval>1.0</defval>
75        </param>
76        <briefdescription>
77<para>constructor. Set lambda. </para>        </briefdescription>
78        <detaileddescription>
79        </detaileddescription>
80        <inbodydescription>
81        </inbodydescription>
82        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="39" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.cpp" bodystart="54" bodyend="56"/>
83        <references refid="classitpp_1_1Gamma__RNG_1dfaae19411e39aa87e1f72e409b6babe" compoundref="itpp__ext_8h" startline="41" endline="41">setup</references>
84      </memberdef>
85      <memberdef kind="function" id="classitpp_1_1Gamma__RNG_1dfaae19411e39aa87e1f72e409b6babe" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
86        <type>void</type>
87        <definition>void itpp::Gamma_RNG::setup</definition>
88        <argsstring>(double a0, double b0)</argsstring>
89        <name>setup</name>
90        <param>
91          <type>double</type>
92          <declname>a0</declname>
93        </param>
94        <param>
95          <type>double</type>
96          <declname>b0</declname>
97        </param>
98        <briefdescription>
99<para>Set lambda. </para>        </briefdescription>
100        <detaileddescription>
101        </detaileddescription>
102        <inbodydescription>
103        </inbodydescription>
104        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="41" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" bodystart="41" bodyend="41"/>
105        <referencedby refid="classitpp_1_1Gamma__RNG_1e132860f825f427d63652edd02c25b54" compoundref="itpp__ext_8cpp" startline="54" endline="56">Gamma_RNG</referencedby>
106        <referencedby refid="classegamma_18e10c0021b5dfdd9cb62c6959b5ef425" compoundref="libEF_8cpp" startline="55" endline="66">egamma::sample</referencedby>
107      </memberdef>
108      <memberdef kind="function" id="classitpp_1_1Gamma__RNG_18e666953249038f262cece2d3ed952d6" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
109        <type>double</type>
110        <definition>double itpp::Gamma_RNG::get_setup</definition>
111        <argsstring>() const </argsstring>
112        <name>get_setup</name>
113        <briefdescription>
114<para>get lambda </para>        </briefdescription>
115        <detaileddescription>
116        </detaileddescription>
117        <inbodydescription>
118        </inbodydescription>
119        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="43"/>
120      </memberdef>
121      <memberdef kind="function" id="classitpp_1_1Gamma__RNG_198e2e65456bca33fca602b2bd607235e" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
122        <type>double</type>
123        <definition>double itpp::Gamma_RNG::operator()</definition>
124        <argsstring>()</argsstring>
125        <name>operator()</name>
126        <briefdescription>
127<para>Get one sample. </para>        </briefdescription>
128        <detaileddescription>
129        </detaileddescription>
130        <inbodydescription>
131        </inbodydescription>
132        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="45" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" bodystart="45" bodyend="45"/>
133      </memberdef>
134      <memberdef kind="function" id="classitpp_1_1Gamma__RNG_1d407bbcda8a39e3f07cac3fdf58ca430" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
135        <type>vec</type>
136        <definition>vec itpp::Gamma_RNG::operator()</definition>
137        <argsstring>(int n)</argsstring>
138        <name>operator()</name>
139        <param>
140          <type>int</type>
141          <declname>n</declname>
142        </param>
143        <briefdescription>
144<para>Get a sample vector. </para>        </briefdescription>
145        <detaileddescription>
146        </detaileddescription>
147        <inbodydescription>
148        </inbodydescription>
149        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="47"/>
150      </memberdef>
151      <memberdef kind="function" id="classitpp_1_1Gamma__RNG_17b82b9d6c35579ab04f1a86a17571b47" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
152        <type>mat</type>
153        <definition>mat itpp::Gamma_RNG::operator()</definition>
154        <argsstring>(int h, int w)</argsstring>
155        <name>operator()</name>
156        <param>
157          <type>int</type>
158          <declname>h</declname>
159        </param>
160        <param>
161          <type>int</type>
162          <declname>w</declname>
163        </param>
164        <briefdescription>
165<para>Get a sample matrix. </para>        </briefdescription>
166        <detaileddescription>
167        </detaileddescription>
168        <inbodydescription>
169        </inbodydescription>
170        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="49"/>
171      </memberdef>
172      </sectiondef>
173      <sectiondef kind="private-func">
174      <memberdef kind="function" id="classitpp_1_1Gamma__RNG_1d79da7d042746e5aeb1a5b03976dda75" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
175        <type>double</type>
176        <definition>double itpp::Gamma_RNG::sample</definition>
177        <argsstring>()</argsstring>
178        <name>sample</name>
179        <briefdescription>
180        </briefdescription>
181        <detaileddescription>
182        </detaileddescription>
183        <inbodydescription>
184        </inbodydescription>
185        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="53" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.cpp" bodystart="83" bodyend="248"/>
186      </memberdef>
187      <memberdef kind="function" id="classitpp_1_1Gamma__RNG_1f92a9aa55ca475684f90e5038c0a71aa" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
188        <type>double</type>
189        <definition>double itpp::Gamma_RNG::exp_rand</definition>
190        <argsstring>()</argsstring>
191        <name>exp_rand</name>
192        <briefdescription>
193<para>compatibility with R </para>        </briefdescription>
194        <detaileddescription>
195        </detaileddescription>
196        <inbodydescription>
197        </inbodydescription>
198        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="62" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" bodystart="62" bodyend="62"/>
199      </memberdef>
200      <memberdef kind="function" id="classitpp_1_1Gamma__RNG_15b4e119a117c9cfbac32ee049041bdaf" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
201        <type>double</type>
202        <definition>double itpp::Gamma_RNG::unif_rand</definition>
203        <argsstring>()</argsstring>
204        <name>unif_rand</name>
205        <briefdescription>
206        </briefdescription>
207        <detaileddescription>
208        </detaileddescription>
209        <inbodydescription>
210        </inbodydescription>
211        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="63" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" bodystart="63" bodyend="63"/>
212      </memberdef>
213      <memberdef kind="function" id="classitpp_1_1Gamma__RNG_1a31b7f8351edf823932e7e7b1c18dd76" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
214        <type>double</type>
215        <definition>double itpp::Gamma_RNG::norm_rand</definition>
216        <argsstring>()</argsstring>
217        <name>norm_rand</name>
218        <briefdescription>
219        </briefdescription>
220        <detaileddescription>
221        </detaileddescription>
222        <inbodydescription>
223        </inbodydescription>
224        <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="64" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" bodystart="64" bodyend="64"/>
225      </memberdef>
226      </sectiondef>
227    <briefdescription>
228<para>Gamma distribution. </para>    </briefdescription>
229    <detaileddescription>
230    </detaileddescription>
231    <location file="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" line="36" bodyfile="/home/smidl/work/git/mixpp/bdm/itpp_ext.h" bodystart="36" bodyend="66"/>
232    <listofallmembers>
233      <member refid="classitpp_1_1Gamma__RNG_18f1b44b286dc0f2d2cd604fb44ba5955" prot="private" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>alpha</name></member>
234      <member refid="classitpp_1_1Gamma__RNG_1271318dafa207cb392b1a95a10b271ee" prot="private" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>beta</name></member>
235      <member refid="classitpp_1_1Gamma__RNG_1f92a9aa55ca475684f90e5038c0a71aa" prot="private" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>exp_rand</name></member>
236      <member refid="classitpp_1_1Gamma__RNG_1e132860f825f427d63652edd02c25b54" prot="public" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>Gamma_RNG</name></member>
237      <member refid="classitpp_1_1Gamma__RNG_18e666953249038f262cece2d3ed952d6" prot="public" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>get_setup</name></member>
238      <member refid="classitpp_1_1Gamma__RNG_1a31b7f8351edf823932e7e7b1c18dd76" prot="private" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>norm_rand</name></member>
239      <member refid="classitpp_1_1Gamma__RNG_1af4a6b9ab9dd8fad2fe7fe7fa63192c3" prot="private" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>NRNG</name></member>
240      <member refid="classitpp_1_1Gamma__RNG_198e2e65456bca33fca602b2bd607235e" prot="public" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>operator()</name></member>
241      <member refid="classitpp_1_1Gamma__RNG_1d407bbcda8a39e3f07cac3fdf58ca430" prot="public" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>operator()</name></member>
242      <member refid="classitpp_1_1Gamma__RNG_17b82b9d6c35579ab04f1a86a17571b47" prot="public" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>operator()</name></member>
243      <member refid="classitpp_1_1Gamma__RNG_11d8015477d8cb406a912dce969a85b60" prot="private" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>RNG</name></member>
244      <member refid="classitpp_1_1Gamma__RNG_1d79da7d042746e5aeb1a5b03976dda75" prot="private" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>sample</name></member>
245      <member refid="classitpp_1_1Gamma__RNG_1dfaae19411e39aa87e1f72e409b6babe" prot="public" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>setup</name></member>
246      <member refid="classitpp_1_1Gamma__RNG_15b4e119a117c9cfbac32ee049041bdaf" prot="private" virt="non-virtual"><scope>itpp::Gamma_RNG</scope><name>unif_rand</name></member>
247    </listofallmembers>
248  </compounddef>
249</doxygen>
Note: See TracBrowser for help on using the browser.