pod/QRNG.pod

   1 %perlcode %{
   2
   3 @EXPORT_OK = qw($gsl_qrng_niederreiter_2 $gsl_qrng_sobol $gsl_qrng_halton $gsl_qrng_reversehalton
   4                 gsl_qrng_alloc gsl_qrng_memcpy gsl_qrng_clone
   5                 gsl_qrng_free  gsl_qrng_init gsl_qrng_name
   6                 gsl_qrng_size gsl_qrng_state gsl_qrng_get
   7             );
   8 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
   9
  10
  11 __END__
  12
  13 =head1 NAME
  14
  15 Math::GSL::QRNG - Quasi-random number generator
  16
  17 =head1 SYNOPSIS
  18
  19 use Math::GSL::QRNG qw/:all/;
  20
  21 =head1 DESCRIPTION
  22
  23 Here is a list of all the functions included in this module :
  24
  25 =over
  26
  27 =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.
  28
  29 =item C<gsl_qrng_clone($q)> - This function returns a pointer to a newly created generator which is an exact copy of the generator $q.
  30
  31 =item C<gsl_qrng_memcpy($dest, $src)> - This function copies the quasi-random sequence generator $src into the pre-existing generator $dest, making $dest into an exact copy of $src. The two generators must be of the same type.
  32
  33 =item C<gsl_qrng_free($q)> - This function frees all the memory associated with the generator $q.
  34
  35 =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.
  36
  37 =item C<gsl_qrng_name($q)> - This function returns a pointer to the name of the generator $q.
  38
  39 =item C<gsl_qrng_size($q)> - This function returns the size of the state of generator r from the generator $q. You can use this information to access the state directly.
  40
  41 =item C<gsl_qrng_state($q)> - This function returns a pointer to the state of generator r from the generator $q. You can use this information to access the state directly.
  42
  43 =item C<gsl_qrng_get>
  44
  45 =back
  46
  47 This module also contains the following constants :
  48
  49 =over
  50
  51 =item C<$gsl_qrng_niederreiter_2>
  52
  53 =item C<$gsl_qrng_sobol>
  54
  55 =item C<$gsl_qrng_halton>
  56
  57 =item C<$gsl_qrng_reversehalton>
  58
  59 =back
  60
  61 For more informations on the functions, we refer you to the GSL offcial documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
  62
  63 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
  64
  65
  66 =head1 EXAMPLES
  67
  68 =head1 AUTHORS
  69
  70 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
  71
  72 =head1 COPYRIGHT AND LICENSE
  73
  74 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
  75
  76 This program is free software; you can redistribute it and/or modify it
  77 under the same terms as Perl itself.
  78
  79 =cut
  80 %}
  81