Finish pod separation and add stub tests for remaining subsystems
[Math-GSL.git] / pod / Monte.pod
blob57baebd0110cab5050affdab8d9723a5f7fd0447
1 %perlcode %{
2 @EXPORT_OK = qw/
3                gsl_monte_miser_integrate 
4                gsl_monte_miser_alloc 
5                gsl_monte_miser_init 
6                gsl_monte_miser_free 
7                gsl_monte_plain_integrate 
8                gsl_monte_plain_alloc 
9                gsl_monte_plain_init 
10                gsl_monte_plain_free 
11                gsl_monte_vegas_integrate 
12                gsl_monte_vegas_alloc 
13                gsl_monte_vegas_init 
14                gsl_monte_vegas_free 
15                $GSL_VEGAS_MODE_IMPORTANCE 
16                $GSL_VEGAS_MODE_IMPORTANCE_ONLY 
17                $GSL_VEGAS_MODE_STRATIFIED 
18              /;
19 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
21 __END__
23 =head1 NAME
25 Math::GSL::Monte - Routines for multidimensional Monte Carlo integration
27 =head1 SYNOPSIS
29 This module is not yet implemented. Patches Welcome!
31     use Math::GSL::Monte qw /:all/;
33 =head1 DESCRIPTION
35 Here is a list of all the functions in this module :
37 =over 
39 =item * C<gsl_monte_miser_integrate >
41 =item * C<gsl_monte_miser_alloc >
43 =item * C<gsl_monte_miser_init >
45 =item * C<gsl_monte_miser_free >
47 =item * C<gsl_monte_plain_integrate >
49 =item * C<gsl_monte_plain_alloc >
51 =item * C<gsl_monte_plain_init >
53 =item * C<gsl_monte_plain_free >
55 =item * C<gsl_monte_vegas_integrate >
57 =item * C<gsl_monte_vegas_alloc >
59 =item * C<gsl_monte_vegas_init >
61 =item * C<gsl_monte_vegas_free >
63 =back
65 This module also includes the following constants :
67 =over
69 =item * $GSL_VEGAS_MODE_IMPORTANCE 
71 =item * $GSL_VEGAS_MODE_IMPORTANCE_ONLY 
73 =item * $GSL_VEGAS_MODE_STRATIFIED 
75 =back
77 For more informations on the functions, we refer you to the GSL offcial
78 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
80 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
83 =head1 AUTHORS
85 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
87 =head1 COPYRIGHT AND LICENSE
89 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
91 This program is free software; you can redistribute it and/or modify it
92 under the same terms as Perl itself.
94 =cut