DHT.i

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