QRNG.i

   1 %module QRNG
   2
   3 %include "typemaps.i"
   4
   5 %apply double *OUTPUT { double x[] };
   6
   7 %{
   8     #include "gsl/gsl_types.h"
   9     #include "gsl/gsl_qrng.h"
  10 %}
  11
  12 %include "gsl/gsl_types.h"
  13 %include "gsl/gsl_qrng.h"
  14
  15 %perlcode %{
  16
  17 @EXPORT_OK = qw($gsl_qrng_niederreiter_2 $gsl_qrng_sobol $gsl_qrng_halton $gsl_qrng_reversehalton
  18                 gsl_qrng_alloc gsl_qrng_memcpy gsl_qrng_clone
  19                 gsl_qrng_free  gsl_qrng_init gsl_qrng_name
  20                 gsl_qrng_size gsl_qrng_state gsl_qrng_get
  21             );
  22 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  23
  24
  25 __END__
  26
  27 =head1 NAME
  28
  29 Math::GSL::QRNG - Quasi-random number generator
  30
  31 =head1 SYNOPSIS
  32
  33 use Math::GSL::QRNG qw/:all/;
  34
  35 =head1 DESCRIPTION
  36
  37 Here is a list of all the functions included in this module :
  38
  39 =over
  40
  41 =item C<gsl_qrng_alloc($T, $n)> - This function returns a pointer to a newly-created instance of a quasi-random sequence generator of type $T and dimension $d. The type $T must be one of the constants included in this module.
  42
  43
  44 =item C<gsl_qrng_clone>
  45
  46 =item C<gsl_qrng_memcpy> -
  47
  48 =item C<gsl_qrng_free($q)> - This function frees all the memory associated with the generator $q.
  49
  50 =item C<gsl_qrng_init($q)> - This function reinitializes the generator $q to its starting point. Note that quasi-random sequences do not use a seed and always produce the same set of values.
  51
  52 =item C<gsl_qrng_name($q)> - This function returns a pointer to the name of the generator $q.
  53
  54 =item C<gsl_qrng_size>
  55
  56 =item C<gsl_qrng_state>
  57
  58 =item C<gsl_qrng_get>
  59
  60 =back
  61
  62 This module also contains the following constants :
  63
  64 =over
  65
  66 =item C<$gsl_qrng_niederreiter_2>
  67
  68 =item C<$gsl_qrng_sobol>
  69
  70 =item C<$gsl_qrng_halton>
  71
  72 =item C<$gsl_qrng_reversehalton>
  73
  74 =back
  75
  76 For more informations on the functions, we refer you to the GSL offcial documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
  77
  78 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
  79
  80
  81 =head1 EXAMPLES
  82
  83 =head1 AUTHOR
  84
  85 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
  86
  87 =head1 COPYRIGHT AND LICENSE
  88
  89 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
  90
  91 This program is free software; you can redistribute it and/or modify it
  92 under the same terms as Perl itself.
  93
  94 =cut
  95 %}