pod/BSpline.pod

   1 %perlcode %{
   2 @EXPORT_OK = qw/
   3                gsl_bspline_alloc
   4                gsl_bspline_free
   5                gsl_bspline_ncoeffs
   6                gsl_bspline_order
   7                gsl_bspline_nbreak
   8                gsl_bspline_breakpoint
   9                gsl_bspline_knots
  10                gsl_bspline_knots_uniform
  11                gsl_bspline_eval
  12              /;
  13 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  14
  15 __END__
  16
  17 =head1 NAME
  18
  19 Math::GSL::BSpline - Functions for the computation of smoothing basis splines
  20
  21 =head1 SYNOPSIS
  22
  23 use Math::GSL::BSpline qw/:all/;
  24
  25 =head1 DESCRIPTION
  26
  27  Here is a list of all the functions included in this module :
  28
  29  gsl_bspline_alloc($k, $nbreak) - This function allocates a workspace for computing B-splines of order $k. The number of breakpoints is given by $nbreak. This leads to n = $nbreak + $k - 2 basis functions. Cubic B-splines are specified by $k = 4.
  30  gsl_bspline_free($w) - This function frees the memory associated with the workspace $w.
  31  gsl_bspline_ncoeffs($w) - This function returns the number of B-spline coefficients given by n = nbreak + k - 2.
  32  gsl_bspline_order
  33  gsl_bspline_nbreak
  34  gsl_bspline_breakpoint
  35  gsl_bspline_knots($breakpts, $w) - This function computes the knots associated with the given breakpoints inside the vector $breakpts and stores them internally in $w->{knots}.
  36  gsl_bspline_knots_uniform($a, $b, $w) - This function assumes uniformly spaced breakpoints on [$a,$b] and constructs the corresponding knot vector using the previously specified nbreak parameter. The knots are stored in $w->{knots}.
  37  gsl_bspline_eval($x, $B, $w) - This function evaluates all B-spline basis functions at the position $x and stores them in the vector $B, so that the ith element of $B is B_i($x). $B must be of length n = $nbreak + $k - 2. This value may also be obtained by calling gsl_bspline_ncoeffs. It is far more efficient to compute all of the basis functions at once than to compute them individually, due to the nature of the defining recurrence relation.
  38
  39  For more informations on the functions, we refer you to the GSL offcial documentation:
  40  http://www.gnu.org/software/gsl/manual/html_node/
  41  Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
  42
  43 =head1 EXAMPLES
  44
  45
  46 =head1 AUTHORS
  47
  48 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
  49
  50 =head1 COPYRIGHT AND LICENSE
  51
  52 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
  53
  54 This program is free software; you can redistribute it and/or modify it
  55 under the same terms as Perl itself.
  56
  57 =cut
  58
  59 %}