Comment out some more free() calls, which need to be turned on per-subsystem to weed...
[Math-GSL.git] / pod / CDF.pod
blob640e9160c50556546949ed65a0e6e29c6ed9e931
1 %perlcode %{
3 our @EXPORT_OK = qw/ gsl_cdf_ugaussian_P gsl_cdf_ugaussian_Q gsl_cdf_ugaussian_Pinv 
4 gsl_cdf_ugaussian_Qinv gsl_cdf_gaussian_P gsl_cdf_gaussian_Q 
5 gsl_cdf_gaussian_Pinv gsl_cdf_gaussian_Qinv gsl_cdf_gamma_P 
6 gsl_cdf_gamma_Q gsl_cdf_gamma_Pinv gsl_cdf_gamma_Qinv 
7 gsl_cdf_cauchy_P gsl_cdf_cauchy_Q gsl_cdf_cauchy_Pinv 
8 gsl_cdf_cauchy_Qinv gsl_cdf_laplace_P gsl_cdf_laplace_Q 
9 gsl_cdf_laplace_Pinv gsl_cdf_laplace_Qinv gsl_cdf_rayleigh_P 
10 gsl_cdf_rayleigh_Q gsl_cdf_rayleigh_Pinv gsl_cdf_rayleigh_Qinv 
11 gsl_cdf_chisq_P gsl_cdf_chisq_Q gsl_cdf_chisq_Pinv 
12 gsl_cdf_chisq_Qinv gsl_cdf_exponential_P gsl_cdf_exponential_Q 
13 gsl_cdf_exponential_Pinv gsl_cdf_exponential_Qinv gsl_cdf_exppow_P 
14 gsl_cdf_exppow_Q gsl_cdf_tdist_P gsl_cdf_tdist_Q 
15 gsl_cdf_tdist_Pinv gsl_cdf_tdist_Qinv gsl_cdf_fdist_P 
16 gsl_cdf_fdist_Q gsl_cdf_fdist_Pinv gsl_cdf_fdist_Qinv 
17 gsl_cdf_beta_P gsl_cdf_beta_Q gsl_cdf_beta_Pinv 
18 gsl_cdf_beta_Qinv gsl_cdf_flat_P gsl_cdf_flat_Q 
19 gsl_cdf_flat_Pinv gsl_cdf_flat_Qinv gsl_cdf_lognormal_P 
20 gsl_cdf_lognormal_Q gsl_cdf_lognormal_Pinv gsl_cdf_lognormal_Qinv 
21 gsl_cdf_gumbel1_P gsl_cdf_gumbel1_Q gsl_cdf_gumbel1_Pinv 
22 gsl_cdf_gumbel1_Qinv gsl_cdf_gumbel2_P gsl_cdf_gumbel2_Q 
23 gsl_cdf_gumbel2_Pinv gsl_cdf_gumbel2_Qinv gsl_cdf_weibull_P 
24 gsl_cdf_weibull_Q gsl_cdf_weibull_Pinv gsl_cdf_weibull_Qinv 
25 gsl_cdf_pareto_P gsl_cdf_pareto_Q gsl_cdf_pareto_Pinv 
26 gsl_cdf_pareto_Qinv gsl_cdf_logistic_P gsl_cdf_logistic_Q 
27 gsl_cdf_logistic_Pinv gsl_cdf_logistic_Qinv gsl_cdf_binomial_P 
28 gsl_cdf_binomial_Q gsl_cdf_poisson_P gsl_cdf_poisson_Q 
29 gsl_cdf_geometric_P gsl_cdf_geometric_Q gsl_cdf_negative_binomial_P 
30 gsl_cdf_negative_binomial_Q gsl_cdf_pascal_P gsl_cdf_pascal_Q 
31 gsl_cdf_hypergeometric_P gsl_cdf_hypergeometric_Q
32                 /;
33 our %EXPORT_TAGS = ( all =>  [  @EXPORT_OK ], geometric => [ gsl_cdf_geometric_P , gsl_cdf_geometric_Q ], tdist => [ gsl_cdf_tdist_P , gsl_cdf_tdist_Q , gsl_cdf_tdist_Pinv , gsl_cdf_tdist_Qinv ], ugaussian => [ gsl_cdf_ugaussian_P , gsl_cdf_ugaussian_Q , gsl_cdf_ugaussian_Pinv , gsl_cdf_ugaussian_Qinv ], rayleigh => [ gsl_cdf_rayleigh_P , gsl_cdf_rayleigh_Q , gsl_cdf_rayleigh_Pinv , gsl_cdf_rayleigh_Qinv ], pascal => [ gsl_cdf_pascal_P , gsl_cdf_pascal_Q ], exponential => [ gsl_cdf_exponential_P , gsl_cdf_exponential_Q , gsl_cdf_exponential_Pinv , gsl_cdf_exponential_Qinv ], gumbel2 => [ gsl_cdf_gumbel2_P , gsl_cdf_gumbel2_Q , gsl_cdf_gumbel2_Pinv , gsl_cdf_gumbel2_Qinv ], gumbel1 => [ gsl_cdf_gumbel1_P , gsl_cdf_gumbel1_Q , gsl_cdf_gumbel1_Pinv , gsl_cdf_gumbel1_Qinv ], exppow => [ gsl_cdf_exppow_P , gsl_cdf_exppow_Q ], logistic => [ gsl_cdf_logistic_P , gsl_cdf_logistic_Q , gsl_cdf_logistic_Pinv , gsl_cdf_logistic_Qinv ], weibull => [ gsl_cdf_weibull_P , gsl_cdf_weibull_Q , gsl_cdf_weibull_Pinv , gsl_cdf_weibull_Qinv ], gaussian => [ gsl_cdf_gaussian_P , gsl_cdf_gaussian_Q , gsl_cdf_gaussian_Pinv , gsl_cdf_gaussian_Qinv ], poisson => [ gsl_cdf_poisson_P , gsl_cdf_poisson_Q ], beta => [ gsl_cdf_beta_P , gsl_cdf_beta_Q , gsl_cdf_beta_Pinv , gsl_cdf_beta_Qinv ], binomial => [ gsl_cdf_binomial_P , gsl_cdf_binomial_Q ], laplace => [ gsl_cdf_laplace_P , gsl_cdf_laplace_Q , gsl_cdf_laplace_Pinv , gsl_cdf_laplace_Qinv ], lognormal => [ gsl_cdf_lognormal_P , gsl_cdf_lognormal_Q , gsl_cdf_lognormal_Pinv , gsl_cdf_lognormal_Qinv ], cauchy => [ gsl_cdf_cauchy_P , gsl_cdf_cauchy_Q , gsl_cdf_cauchy_Pinv , gsl_cdf_cauchy_Qinv ], fdist => [ gsl_cdf_fdist_P , gsl_cdf_fdist_Q , gsl_cdf_fdist_Pinv , gsl_cdf_fdist_Qinv ], chisq => [ gsl_cdf_chisq_P , gsl_cdf_chisq_Q , gsl_cdf_chisq_Pinv , gsl_cdf_chisq_Qinv ], gamma => [ gsl_cdf_gamma_P , gsl_cdf_gamma_Q , gsl_cdf_gamma_Pinv , gsl_cdf_gamma_Qinv ], hypergeometric => [ gsl_cdf_hypergeometric_P , gsl_cdf_hypergeometric_Q ], negative => [ gsl_cdf_negative_binomial_P , gsl_cdf_negative_binomial_Q ], pareto => [ gsl_cdf_pareto_P , gsl_cdf_pareto_Q , gsl_cdf_pareto_Pinv , gsl_cdf_pareto_Qinv ], flat => [ gsl_cdf_flat_P , gsl_cdf_flat_Q , gsl_cdf_flat_Pinv , gsl_cdf_flat_Qinv ]);
35 __END__
37 =head1 NAME
39 Math::GSL::CDF - Cumulative Distribution Functions
41 =head1 SYNOPSIS
43     use Math::GSL::CDF qw /:all/;
44     my $x = gsl_cdf_gaussian_Pinv($P, $sigma);
46 These functions compute the cumulative distribution functions P(x), Q(x) and
47 their inverses for the named distributions.
49 =head1 DESCRIPTION
51  Here is a list of all the functions included in this module :
53  gsl_cdf_ugaussian_P($x)
54  gsl_cdf_ugaussian_Q($x)
55  gsl_cdf_ugaussian_Pinv($P) 
56  gsl_cdf_ugaussian_Qinv($Q)
57  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the unit Gaussian distribution. 
59  gsl_cdf_gaussian_P($x, $sigma)
60  gsl_cdf_gaussian_Q($x, $sigma) 
61  gsl_cdf_gaussian_Pinv($P, $sigma)
62  gsl_cdf_gaussian_Qinv($Q, $sigma)
63  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the Gaussian distribution with standard deviation $sigma. 
65  gsl_cdf_gamma_P($x, $a, $b) 
66  gsl_cdf_gamma_Q($x, $a, $b)
67  gsl_cdf_gamma_Pinv($P, $a, $b)
68  gsl_cdf_gamma_Qinv($Q, $a, $b)
69  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the gamma distribution with parameters $a and $b. 
71  gsl_cdf_cauchy_P($x, $a)
72  gsl_cdf_cauchy_Q($x, $a)
73  gsl_cdf_cauchy_Pinv($P, $a)
74  gsl_cdf_cauchy_Qinv($Q, $a)
75  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the Cauchy distribution with scale parameter $a. 
77  gsl_cdf_laplace_P($x, $a)
78  gsl_cdf_laplace_Q($x, $a) 
79  gsl_cdf_laplace_Pinv($P, $a)
80  gsl_cdf_laplace_Qinv($Q, $a)
81  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the Laplace distribution with width $a. 
83  gsl_cdf_rayleigh_P($x, $sigma) 
84  gsl_cdf_rayleigh_Q($x, $sigma)
85  gsl_cdf_rayleigh_Pinv($P, $sigma)
86  gsl_cdf_rayleigh_Qinv($Q, $sigma) 
87  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the Rayleigh distribution with scale parameter $sigma.  
89  gsl_cdf_chisq_P($x, $nu)
90  gsl_cdf_chisq_Q($x, $nu)
91  gsl_cdf_chisq_Pinv($P, $nu) 
92  gsl_cdf_chisq_Qinv($Q, $nu)
93  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the chi-squared distribution with $nu degrees of freedom. 
95  gsl_cdf_exponential_P($x, $mu)
96  gsl_cdf_exponential_Q($x, $mu) 
97  gsl_cdf_exponential_Pinv($P, $mu)
98  gsl_cdf_exponential_Qinv($Q, $mu)
99  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the Laplace distribution with width $a. 
101  gsl_cdf_exppow_P($x, $a, $b) 
102  gsl_cdf_exppow_Q($x, $a, $b)
103  - These functions compute the cumulative distribution functions P(x), Q(x) for the exponential power distribution with parameters $a and $b. 
105  gsl_cdf_tdist_P($x, $nu)
106  gsl_cdf_tdist_Q($x, $nu) 
107  gsl_cdf_tdist_Pinv($P, $nu)
108  gsl_cdf_tdist_Qinv($Q, $nu)
109  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the t-distribution with $nu degrees of freedom.
111  gsl_cdf_fdist_P($x, $nu1, $nu2) 
112  gsl_cdf_fdist_Q($x, $nu1, $nu2)
113  gsl_cdf_fdist_Pinv($P, $nu1, $nu2)
114  gsl_cdf_fdist_Qinv($Q, $nu1, $nu2) 
115  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the F-distribution with $nu1 and $nu2 degrees of freedom. 
117  gsl_cdf_beta_P($x, $a, $b)
118  gsl_cdf_beta_Q($x, $a, $b)
119  gsl_cdf_beta_Pinv($P, $a, $b) 
120  gsl_cdf_beta_Qinv($Q, $a, $b)
121  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the beta distribution with parameters $a and $b. 
123  gsl_cdf_flat_P($x, $a, $b)
124  gsl_cdf_flat_Q($x, $a, $b) 
125  gsl_cdf_flat_Pinv($P, $a, $b)
126  gsl_cdf_flat_Qinv($Q, $a, $b)
127  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for a uniform distribution from $a to $b. 
129  gsl_cdf_lognormal_P($x, $zeta, $sigma)
130  gsl_cdf_lognormal_Q($x, $zeta, $sigma)
131  gsl_cdf_lognormal_Pinv($P, $zeta, $sigma)
132  gsl_cdf_lognormal_Qinv($Q, $zeta, $sigma) 
133  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the lognormal distribution with parameters $zeta and $sigma. 
135  gsl_cdf_gumbel1_P($x, $a, $b)
136  gsl_cdf_gumbel1_Q($x, $a, $b)
137  gsl_cdf_gumbel1_Pinv($P, $a, $b) 
138  gsl_cdf_gumbel1_Qinv($Q, $a, $b)
139  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the Type-1 Gumbel distribution with parameters $a and $b. 
141  gsl_cdf_gumbel2_P($x, $a, $b)
142  gsl_cdf_gumbel2_Q($x, $a, $b) 
143  gsl_cdf_gumbel2_Pinv($P, $a, $b)
144  gsl_cdf_gumbel2_Qinv($Q, $a, $b)
145  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the Type-2 Gumbel distribution with parameters $a and $b. 
147  gsl_cdf_weibull_P($x, $a, $b) 
148  gsl_cdf_weibull_Q($x, $a, $b)
149  gsl_cdf_weibull_Pinv($P, $a, $b)
150  gsl_cdf_weibull_Qinv($Q, $a, $b) 
151  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the Type-1 Gumbel distribution with parameters $a and $b. 
153  gsl_cdf_pareto_P($x, $a, $b)
154  gsl_cdf_pareto_Q($x, $a, $b)
155  gsl_cdf_pareto_Pinv($P, $a, $b) 
156  gsl_cdf_pareto_Qinv($Q, $a, $b)
157  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the Pareto distribution with exponent $a and scale $b.
159  gsl_cdf_logistic_P($x, $a)
160  gsl_cdf_logistic_Q($x, $a) 
161  gsl_cdf_logistic_Pinv($P, $a)
162  gsl_cdf_logistic_Qinv($Q, $a)
163  - These functions compute the cumulative distribution functions P(x), Q(x) and their inverses for the logistic distribution with scale parameter a. 
165  gsl_cdf_binomial_P($k, $p, $n) 
166  gsl_cdf_binomial_Q($k, $p, $n)
167  - These functions compute the cumulative distribution functions P(k), Q(k) for the binomial distribution with parameters $p and $n. 
169  gsl_cdf_poisson_P($k, $mu)
170  gsl_cdf_poisson_Q($k, $mu)
171  - These functions compute the cumulative distribution functions P(k), Q(k) for the Poisson distribution with parameter $mu.  
173  gsl_cdf_geometric_P($k, $p)
174  gsl_cdf_geometric_Q($k, $p)
175  - These functions compute the cumulative distribution functions P(k), Q(k) for the geometric distribution with parameter $p.
177  gsl_cdf_negative_binomial_P($k, $p, $n) 
178  gsl_cdf_negative_binomial_Q($k, $p, $n)
179  - These functions compute the cumulative distribution functions P(k), Q(k) for the negative binomial distribution with parameters $p and $n. 
181  gsl_cdf_pascal_P($k, $p, $n)
182  gsl_cdf_pascal_Q($k, $p, $n)
183  - These functions compute the cumulative distribution functions P(k), Q(k) for the Pascal distribution with parameters $p and $n.  
185  gsl_cdf_hypergeometric_P($k, $n1, $n2, $t)
186  gsl_cdf_hypergeometric_Q($k, $n1, $n2, $t)
187  - These functions compute the cumulative distribution functions P(k), Q(k) for the hypergeometric distribution with parameters $n1, $n2 and $t. 
190  To import specific functions, list them in the use line. To import
191  all function exportable by Math::GSL::CDF do
193     use Math::GSL::CDF qw/:all/
194     
195  This is the list of available import tags:
197 =over
199 =item geometric
201 =item tdist
203 =item ugaussian
205 =item rayleigh
207 =item pascal
209 =item exponential
211 =item gumbel2
213 =item gumbel1
215 =item exppow
217 =item logistic
219 =item weibull
221 =item gaussian
223 =item poisson
225 =item beta
227 =item binomial
229 =item laplace
231 =item lognormal
233 =item cauchy
235 =item fdist
237 =item chisq
239 =item gamma
241 =item hypergeometric
243 =item negative
245 =item pareto
247 =item flat
249  For example the beta tag contains theses functions : gsl_cdf_beta_P,
250  gsl_cdf_beta_Q, gsl_cdf_beta_Pinv, gsl_cdf_beta_Qinv. 
252 For more informations on the functions, we refer you to the GSL offcial documentation: 
253 L<http://www.gnu.org/software/gsl/manual/html_node/>
255  Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
257 =back
259 =head1 EXAMPLES
261 Example using import tags:
263     use Math::GSL::CDF qw /:beta/;
264     print gsl_cdf_beta_P(1,2,3) . "\n";
266 =head1 AUTHORS
268 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
270 =head1 COPYRIGHT AND LICENSE
272 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
274 This program is free software; you can redistribute it and/or modify it
275 under the same terms as Perl itself.
277 =cut