QRNG.i

   1 %module QRNG
   2
   3 %include "typemaps.i"
   4 %include "gsl_typemaps.i"
   5
   6 %apply double *OUTPUT { double x[] };
   7
   8
   9 %typemap(argout) double x[] {
  10     AV *tempav;
  11     I32 len;
  12     int i;
  13     SV **tv;
  14     if (argvi >= items) {
  15         EXTEND(sp,1);
  16     }
  17     $result = sv_newmortal();
  18     sv_setnv($result,(NV) *($1));
  19     argvi++;
  20
  21     $result = sv_newmortal();
  22     sv_setnv($result,(NV) *($1+1));
  23     argvi++;
  24 }
  25
  26 %{
  27     #include "gsl/gsl_types.h"
  28     #include "gsl/gsl_qrng.h"
  29 %}
  30
  31 %include "gsl/gsl_types.h"
  32 %include "gsl/gsl_qrng.h"
  33
  34 %perlcode %{
  35
  36 @EXPORT_OK = qw($gsl_qrng_niederreiter_2 $gsl_qrng_sobol $gsl_qrng_halton $gsl_qrng_reversehalton
  37                 gsl_qrng_alloc gsl_qrng_memcpy gsl_qrng_clone
  38                 gsl_qrng_free  gsl_qrng_init gsl_qrng_name
  39                 gsl_qrng_size gsl_qrng_state gsl_qrng_get
  40             );
  41 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  42
  43
  44 __END__
  45
  46 =head1 NAME
  47
  48 Math::GSL::QRNG - Quasi-random number generator
  49
  50 =head1 SYNOPSIS
  51
  52 use Math::GSL::QRNG qw/:all/;
  53
  54 =head1 DESCRIPTION
  55
  56 Here is a list of all the functions included in this module :
  57
  58 =over
  59
  60 =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.
  61
  62
  63 =item C<gsl_qrng_clone>
  64
  65 =item C<gsl_qrng_memcpy> -
  66
  67 =item C<gsl_qrng_free($q)> - This function frees all the memory associated with the generator $q.
  68
  69 =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.
  70
  71 =item C<gsl_qrng_name($q)> - This function returns a pointer to the name of the generator $q.
  72
  73 =item C<gsl_qrng_size>
  74
  75 =item C<gsl_qrng_state>
  76
  77 =item C<gsl_qrng_get>
  78
  79 =back
  80
  81 This module also contains the following constants :
  82
  83 =over
  84
  85 =item C<$gsl_qrng_niederreiter_2>
  86
  87 =item C<$gsl_qrng_sobol>
  88
  89 =item C<$gsl_qrng_halton>
  90
  91 =item C<$gsl_qrng_reversehalton>
  92
  93 =back
  94
  95 For more informations on the functions, we refer you to the GSL offcial documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
  96
  97 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
  98
  99
 100 =head1 EXAMPLES
 101
 102 =head1 AUTHOR
 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 %}