Starting to clean up the documentation.
[Math-GSL.git] / QRNG.i
blob356be78fff99e178df42be15a1374f94ce1dcff5
1 %module QRNG
2 %{
3 #include "/usr/local/include/gsl/gsl_types.h"
4 #include "/usr/local/include/gsl/gsl_qrng.h"
5 %}
7 %include "/usr/local/include/gsl/gsl_types.h"
8 %include "/usr/local/include/gsl/gsl_qrng.h"
10 %perlcode %{
12 @EXPORT_OK = qw($gsl_qrng_niederreiter_2 $gsl_qrng_sobol $gsl_qrng_halton $gsl_qrng_reversehalton
13 gsl_qrng_alloc gsl_qrng_memcpy gsl_qrng_clone
14 gsl_qrng_free gsl_qrng_init gsl_qrng_name
15 gsl_qrng_size gsl_qrng_state gsl_qrng_get
17 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
20 __END__
22 =head1 NAME
24 Math::GSL::QRNG
26 =head1 SYPNOPSIS
28 use Math::GSL::QRNG qw/:all/;
30 =head1 DESCRIPTION
31 Here is a list of all the functions included in this module :
33 gsl_qrng_alloc gsl_qrng_memcpy gsl_qrng_clone
34 gsl_qrng_free gsl_qrng_init gsl_qrng_name
35 gsl_qrng_size gsl_qrng_state gsl_qrng_get
37 This module also contains the following constants :
38 $gsl_qrng_niederreiter_2
39 $gsl_qrng_sobol
40 $gsl_qrng_halton
41 $gsl_qrng_reversehalton
43 For more informations on the functions, we refer you to the GSL offcial documentation: http://www.gnu.org/software/gsl/manual/html_node/
44 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
46 =head1 EXAMPLES
48 =head1 AUTHOR
50 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
52 =head1 COPYRIGHT AND LICENSE
54 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
56 This program is free software; you can redistribute it and/or modify it
57 under the same terms as Perl itself.
59 =cut