Comment out some more free() calls, which need to be turned on per-subsystem to weed...
[Math-GSL.git] / pod / Interp.pod
blobedd8ca3e5abe3345423005d821e80fedc35231be
1 %perlcode %{
2 @EXPORT_OK = qw/
3                gsl_interp_accel_alloc 
4                gsl_interp_accel_find 
5                gsl_interp_accel_reset 
6                gsl_interp_accel_free 
7                gsl_interp_alloc 
8                gsl_interp_init 
9                gsl_interp_name 
10                gsl_interp_min_size 
11                gsl_interp_eval_e 
12                gsl_interp_eval 
13                gsl_interp_eval_deriv_e 
14                gsl_interp_eval_deriv 
15                gsl_interp_eval_deriv2_e 
16                gsl_interp_eval_deriv2 
17                gsl_interp_eval_integ_e 
18                gsl_interp_eval_integ 
19                gsl_interp_free 
20                gsl_interp_bsearch
21                $gsl_interp_linear
22                $gsl_interp_polynomial
23                $gsl_interp_cspline
24                $gsl_interp_cspline_periodic
25                $gsl_interp_akima
26                $gsl_interp_akima_periodic
27              /;
28 %EXPORT_TAGS = ( all => \@EXPORT_OK  );
30 __END__
32 =head1 NAME
34 Math::GSL::Interp - Interpolation
36 =head1 SYNOPSIS
38  use Math::GSL::Interp qw/:all/;
40 =head1 DESCRIPTION
42 Here is a list of all the functions included in this module :
44 =over 1
46 =item C<gsl_interp_accel_alloc()> - This function returns a pointer to an accelerator object, which is a kind of iterator for interpolation lookups. It tracks the state of lookups, thus allowing for application of various acceleration strategies.
48 =item C<gsl_interp_accel_find($a, $x_array, $size, $x)> - This function performs a lookup action on the data array $x_array of size $size, using the given accelerator $a. This is how lookups are performed during evaluation of an interpolation. The function returns an index i such that $x_array[i] <= $x < $x_array[i+1].
50 =item C<gsl_interp_accel_reset> 
52 =item C<gsl_interp_accel_free($a)> - This function frees the accelerator object $a. 
54 =item C<gsl_interp_alloc($T, $alloc)> - This function returns a newly allocated interpolation object of type $T for $size data-points. $T must be one of the constants below.  
56 =item C<gsl_interp_init($interp, $xa, $ya, $size)> - This function initializes the interpolation object interp for the data (xa,ya) where xa and ya are arrays of size size. The interpolation object (gsl_interp) does not save the data arrays xa and ya and only stores the static state computed from the data. The xa data array is always assumed to be strictly ordered, with increasing x values; the behavior for other arrangements is not defined. 
58 =item C<gsl_interp_name($interp)> - This function returns the name of the interpolation type used by $interp. 
60 =item C<gsl_interp_min_size($interp)> - This function returns the minimum number of points required by the interpolation type of $interp. For example, Akima spline interpolation requires a minimum of 5 points.
62 =item C<gsl_interp_eval_e($interp, $xa, $ya, $x, $acc)> - This functions returns the interpolated value of y for a given point $x, using the interpolation object $interp, data arrays $xa and $ya and the accelerator $acc. The function returns 0 if the operation succeeded, 1 otherwise and the y value.
64 =item C<gsl_interp_eval($interp, $xa, $ya, $x, $acc)> - This functions returns the interpolated value of y for a given point $x, using the interpolation object $interp, data arrays $xa and $ya and the accelerator $acc. 
66 =item C<gsl_interp_eval_deriv_e($interp, $xa, $ya, $x, $acc)> - This function computes the derivative value of y for a given point $x, using the interpolation object $interp, data arrays $xa and $ya and the accelerator $acc. The function returns 0 if the operation succeeded, 1 otherwise and the d value.
68 =item C<gsl_interp_eval_deriv($interp, $xa, $ya, $x, $acc)> - This function returns the derivative d of an interpolated function for a given point $x, using the interpolation object interp, data arrays $xa and $ya and the accelerator $acc.
70 =item C<gsl_interp_eval_deriv2_e($interp, $xa, $ya, $x, $acc)> - This function computes the second derivative d2 of an interpolated function for a given point $x, using the interpolation object $interp, data arrays $xa and $ya and the accelerator $acc. The function returns 0 if the operation succeeded, 1 otherwise and the d2 value.
72 =item C<gsl_interp_eval_deriv2($interp, $xa, $ya, $x, $acc)> - This function returns the second derivative d2 of an interpolated function for a given point $x, using the interpolation object $interp, data arrays $xa and $ya and the accelerator $acc.
74 =item C<gsl_interp_eval_integ_e($interp, $xa, $ya, $a, $b, $acc)> - This function computes the numerical integral result of an interpolated function over the range [$a, $b], using the interpolation object $interp, data arrays $xa and $ya and the accelerator $acc. The function returns 0 if the operation succeeded, 1 otherwise and the result value.
76 =item C<gsl_interp_eval_integ($interp, $xa, $ya, $a, $b, $acc)> - This function returns the numerical integral result of an interpolated function over the range [$a, $b], using the interpolation object $interp, data arrays $xa and $ya and the accelerator $acc. 
78 =item C<gsl_interp_free($interp)> - This function frees the interpolation object $interp. 
80 =item C<gsl_interp_bsearch($x_array, $x, $index_lo, $index_hi)> - This function returns the index i of the array $x_array such that $x_array[i] <= x < $x_array[i+1]. The index is searched for in the range [$index_lo,$index_hi].
82 =back
84 This module also includes the following constants :
86 =over 1
88 =item C<$gsl_interp_linear> - Linear interpolation
90 =item C<$gsl_interp_polynomial> - Polynomial interpolation. This method should only be used for interpolating small numbers of points because polynomial interpolation introduces large oscillations, even for well-behaved datasets. The number of terms in the interpolating polynomial is equal to the number of points. 
92 =item C<$gsl_interp_cspline> - Cubic spline with natural boundary conditions. The resulting curve is piecewise cubic on each interval, with matching first and second derivatives at the supplied data-points. The second derivative is chosen to be zero at the first point and last point.
94 =item C<$gsl_interp_cspline_periodic> - Cubic spline with periodic boundary conditions. The resulting curve is piecewise cubic on each interval, with matching first and second derivatives at the supplied data-points. The derivatives at the first and last points are also matched. Note that the last point in the data must have the same y-value as the first point, otherwise the resulting periodic interpolation will have a discontinuity at the boundary. 
96 =item C<$gsl_interp_akima> - Non-rounded Akima spline with natural boundary conditions. This method uses the non-rounded corner algorithm of Wodicka. 
98 =item C<$gsl_interp_akima_periodic> - Non-rounded Akima spline with periodic boundary conditions. This method uses the non-rounded corner algorithm of Wodicka.
100 =back
102 =head1 EXAMPLES
104  use Math::GSL::Interp qw/:all/;
105  my $x_array = [ 0.0, 1.0, 2.0, 3.0, 4.0 ];
106  # check that we get the last interval if x == last value 
107  $index_result = gsl_interp_bsearch($x_array, 4.0, 0, 4);
108  print "The last interval is $index_result \n";
110 =head1 AUTHORS
112 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
114 =head1 COPYRIGHT AND LICENSE
116 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
118 This program is free software; you can redistribute it and/or modify it
119 under the same terms as Perl itself.
121 =cut