Adding documentation to NTuple
[Math-GSL.git] / Spline.i
blobe732d350670dd93b9cbf57839ceb81e2f4387021
1 %module "Math::GSL::Spline"
3 %include "typemaps.i"
4 %apply double *OUTPUT { double * y, double * d, double * d2, double * result };
6 %{
7 #include "gsl/gsl_spline.h"
8 %}
10 %include "gsl/gsl_spline.h"
13 %perlcode %{
14 @EXPORT_OK = qw/
15 gsl_spline_alloc
16 gsl_spline_init
17 gsl_spline_name
18 gsl_spline_min_size
19 gsl_spline_eval_e
20 gsl_spline_eval
21 gsl_spline_eval_deriv_e
22 gsl_spline_eval_deriv
23 gsl_spline_eval_deriv2_e
24 gsl_spline_eval_deriv2
25 gsl_spline_eval_integ_e
26 gsl_spline_eval_integ
27 gsl_spline_free
29 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
31 __END__
33 =head1 NAME
35 Math::GSL::Spline - Higher-level Interface to Interp
37 =head1 SYNOPSIS
39 use Math::GSL::Spline qw /:all/;
41 =head1 DESCRIPTION
43 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.
45 Here is a list of all the functions in this module :
47 =over
49 =item * C<gsl_spline_alloc($T, $size)>
51 =item * C<gsl_spline_init($spline, $xa, $ya, $size)>
53 =item * C<gsl_spline_free($spline)>
55 =item * C<gsl_spline_name($spline)>
57 =item * C<gsl_spline_min_size($spline)>
59 =item * C<gsl_spline_eval_e($spline, $x, $acc)>
61 =item * C<gsl_spline_eval($spline, $x, $acc)>
63 =item * C<gsl_spline_eval_deriv_e($spline, $x, $acc)>
65 =item * C<gsl_spline_eval_deriv($spline, $x, $acc)>
67 =item * C<gsl_spline_eval_deriv2_e($spline, $x, $acc)>
69 =item * C<gsl_spline_eval_deriv2($spline, $x, $acc)>
71 =item * C<gsl_spline_eval_integ_e($spline, $a, $b, $acc)>
73 =item * C<gsl_spline_eval_integ($spline, $a, $b, $acc)>
75 =back
77 For more informations on the functions, we refer you to the GSL offcial
78 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
80 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
83 =head1 AUTHORS
85 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
87 =head1 COPYRIGHT AND LICENSE
89 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
91 This program is free software; you can redistribute it and/or modify it
92 under the same terms as Perl itself.
94 =cut