QRNG.i

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