pod/Spline.pod

   1 %perlcode %{
   2 @EXPORT_OK = qw/
   3                gsl_spline_alloc
   4                gsl_spline_init
   5                gsl_spline_name
   6                gsl_spline_min_size
   7                gsl_spline_eval_e
   8                gsl_spline_eval
   9                gsl_spline_eval_deriv_e
  10                gsl_spline_eval_deriv
  11                gsl_spline_eval_deriv2_e
  12                gsl_spline_eval_deriv2
  13                gsl_spline_eval_integ_e
  14                gsl_spline_eval_integ
  15                gsl_spline_free
  16              /;
  17 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  18
  19 __END__
  20
  21 =head1 NAME
  22
  23 Math::GSL::Spline - Higher-level Interface to Interp
  24
  25 =head1 SYNOPSIS
  26
  27 use Math::GSL::Spline qw /:all/;
  28
  29 =head1 DESCRIPTION
  30
  31 The functions described in the Interp module required the user to supply pointers to the x and y arrays on each call. The following functions are equivalent to the corresponding gsl_interp functions but maintain a copy of this data in the gsl_spline object. This removes the need to pass both xa and ya as arguments on each evaluation.
  32
  33 Here is a list of all the functions in this module :
  34
  35 =over
  36
  37 =item * C<gsl_spline_alloc($T, $size)>
  38
  39 =item * C<gsl_spline_init($spline, $xa, $ya, $size)>
  40
  41 =item * C<gsl_spline_free($spline)>
  42
  43 =item * C<gsl_spline_name($spline)>
  44
  45 =item * C<gsl_spline_min_size($spline)>
  46
  47 =item * C<gsl_spline_eval_e($spline, $x, $acc)>
  48
  49 =item * C<gsl_spline_eval($spline, $x, $acc)>
  50
  51 =item * C<gsl_spline_eval_deriv_e($spline, $x, $acc)>
  52
  53 =item * C<gsl_spline_eval_deriv($spline, $x, $acc)>
  54
  55 =item * C<gsl_spline_eval_deriv2_e($spline, $x, $acc)>
  56
  57 =item * C<gsl_spline_eval_deriv2($spline, $x, $acc)>
  58
  59 =item * C<gsl_spline_eval_integ_e($spline, $a, $b, $acc)>
  60
  61 =item * C<gsl_spline_eval_integ($spline, $a, $b, $acc)>
  62
  63 =back
  64
  65 For more informations on the functions, we refer you to the GSL offcial
  66 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
  67
  68 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
  69
  70
  71 =head1 AUTHORS
  72
  73 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
  74
  75 =head1 COPYRIGHT AND LICENSE
  76
  77 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
  78
  79 This program is free software; you can redistribute it and/or modify it
  80 under the same terms as Perl itself.
  81
  82 =cut
  83
  84
  85 %}
  86