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