swig/Monte.i

   1 %module "Math::GSL::Monte"
   2 %include "gsl/gsl_monte.h"
   3 %include "gsl/gsl_monte_miser.h"
   4 %include "gsl/gsl_monte_plain.h"
   5 %include "gsl/gsl_monte_vegas.h"
   6 %include "gsl/gsl_types.h"
   7 %include "gsl/gsl_errno.h"
   8 %include "typemaps.i"
   9 %include "gsl_typemaps.i"
  10
  11 %{
  12     #include "gsl/gsl_monte.h"
  13     #include "gsl/gsl_monte_miser.h"
  14     #include "gsl/gsl_monte_plain.h"
  15     #include "gsl/gsl_monte_vegas.h"
  16     #include "gsl/gsl_types.h"
  17     #include "gsl/gsl_errno.h"
  18 %}
  19
  20 %perlcode %{
  21 @EXPORT_OK = qw/
  22                gsl_monte_miser_integrate
  23                gsl_monte_miser_alloc
  24                gsl_monte_miser_init
  25                gsl_monte_miser_free
  26                gsl_monte_plain_integrate
  27                gsl_monte_plain_alloc
  28                gsl_monte_plain_init
  29                gsl_monte_plain_free
  30                gsl_monte_vegas_integrate
  31                gsl_monte_vegas_alloc
  32                gsl_monte_vegas_init
  33                gsl_monte_vegas_free
  34                $GSL_VEGAS_MODE_IMPORTANCE
  35                $GSL_VEGAS_MODE_IMPORTANCE_ONLY
  36                $GSL_VEGAS_MODE_STRATIFIED
  37              /;
  38 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  39
  40 __END__
  41
  42 =head1 NAME
  43
  44 Math::GSL::Monte - Routines for multidimensional Monte Carlo integration
  45
  46 =head1 SYNOPSIS
  47
  48 This module is not yet implemented. Patches Welcome!
  49
  50     use Math::GSL::Monte qw /:all/;
  51
  52 =head1 DESCRIPTION
  53
  54 Here is a list of all the functions in this module :
  55
  56 =over
  57
  58 =item * C<gsl_monte_miser_integrate >
  59
  60 =item * C<gsl_monte_miser_alloc >
  61
  62 =item * C<gsl_monte_miser_init >
  63
  64 =item * C<gsl_monte_miser_free >
  65
  66 =item * C<gsl_monte_plain_integrate >
  67
  68 =item * C<gsl_monte_plain_alloc >
  69
  70 =item * C<gsl_monte_plain_init >
  71
  72 =item * C<gsl_monte_plain_free >
  73
  74 =item * C<gsl_monte_vegas_integrate >
  75
  76 =item * C<gsl_monte_vegas_alloc >
  77
  78 =item * C<gsl_monte_vegas_init >
  79
  80 =item * C<gsl_monte_vegas_free >
  81
  82 =back
  83
  84 This module also includes the following constants :
  85
  86 =over
  87
  88 =item * $GSL_VEGAS_MODE_IMPORTANCE
  89
  90 =item * $GSL_VEGAS_MODE_IMPORTANCE_ONLY
  91
  92 =item * $GSL_VEGAS_MODE_STRATIFIED
  93
  94 =back
  95
  96 For more informations on the functions, we refer you to the GSL offcial
  97 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
  98
  99 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
 100
 101
 102 =head1 AUTHORS
 103
 104 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 105
 106 =head1 COPYRIGHT AND LICENSE
 107
 108 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 109
 110 This program is free software; you can redistribute it and/or modify it
 111 under the same terms as Perl itself.
 112
 113 =cut
 114
 115
 116 %}