DHT.i

   1 %module DHT
   2 %{
   3     #include "/usr/local/include/gsl/gsl_dht.h"
   4 %}
   5
   6 %include "/usr/local/include/gsl/gsl_dht.h"
   7
   8
   9 %perlcode %{
  10 @EXPORT_OK = qw/
  11                gsl_dht_alloc
  12                gsl_dht_new
  13                gsl_dht_init
  14                gsl_dht_x_sample
  15                gsl_dht_k_sample
  16                gsl_dht_free
  17                gsl_dht_apply
  18              /;
  19 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  20
  21 __END__
  22
  23 =head1 NAME
  24
  25 Math::GSL::DHT - Functions for performing Discrete Hankel Transforms
  26
  27 =head1 SYPNOPSIS
  28
  29 use Math::GSL::DHT qw/:all/;
  30
  31 =head1 DESCRIPTION
  32
  33 Here is a list of all the functions included in this module :
  34
  35 =over
  36
  37 =item C<gsl_dht_alloc($size)> - This function allocates a Discrete Hankel transform object of size $size.
  38
  39 =item C<gsl_dht_new($size, $nu, $xmax)> -  This function allocates a Discrete Hankel transform object of size $size and initializes it for the given values of $nu and $xmax.
  40
  41 =item C<gsl_dht_init($t, $nu, $xmax)> - This function initializes the transform $t for the given values of $nu and $xmax.
  42
  43 =item C<gsl_dht_x_sample($t, $n)> - This function returns the value of the $n-th sample point in the unit interval, (j_{\nu,n+1}/j_{\nu,M}) X. These are the points where the function f(t) is assumed to be sampled.
  44
  45 =item C<gsl_dht_k_sample($t, $n)> - This function returns the value of the $n-th sample point in “k-space”, j_{\nu,n+1}/X.
  46
  47 =item C<gsl_dht_free($t)> - This function frees the transform $t.
  48
  49 =item C<gsl_dht_apply>
  50
  51 =back
  52
  53 =head1 EXAMPLES
  54
  55 =head1 AUTHOR
  56
  57 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
  58
  59 =head1 COPYRIGHT AND LICENSE
  60
  61 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
  62
  63 This program is free software; you can redistribute it and/or modify it
  64 under the same terms as Perl itself.
  65
  66 =cut
  67 %}