pod/DHT.pod

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