Chebyshev.i

   1 %module "Math::GSL::Chebyshev"
   2 %include "typemaps.i"
   3 %include "gsl_typemaps.i"
   4 %{
   5     #include "gsl/gsl_chebyshev.h"
   6     #include "gsl/gsl_math.h"
   7     #include "gsl/gsl_mode.h"
   8 %}
   9 %include "gsl/gsl_chebyshev.h"
  10 %include "gsl/gsl_math.h"
  11 %include "gsl/gsl_mode.h"
  12
  13
  14 %perlcode %{
  15 @EXPORT_OK = qw/
  16                gsl_cheb_alloc
  17                gsl_cheb_free
  18                gsl_cheb_init
  19                gsl_cheb_eval
  20                gsl_cheb_eval_err
  21                gsl_cheb_eval_n
  22                gsl_cheb_eval_n_err
  23                gsl_cheb_eval_mode
  24                gsl_cheb_eval_mode_e
  25                gsl_cheb_calc_deriv
  26                gsl_cheb_calc_integ
  27              /;
  28 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  29
  30 __END__
  31
  32 =head1 NAME
  33
  34 Math::GSL::Chebyshev - Univariate Chebyshev Series Approximation
  35
  36 =head1 SYNOPSIS
  37
  38     use Math::GSL::Chebyshev qw /:all/;
  39
  40     my $cheb             = gsl_cheb_alloc(40);
  41     my $function         = sub { sin(cos($_[0])) };
  42
  43     gsl_cheb_init($cheb, $function, 0, 10);
  44
  45     my $x                = gsl_cheb_eval($cheb, 5.5 );
  46     my ($status,$y,$err) = gsl_cheb_eval_err($cheb, 7.5 );
  47     gsl_cheb_free($cheb);
  48
  49 =head1 DESCRIPTION
  50
  51 Here is a list of all the functions in this module :
  52
  53 =over
  54
  55 =item * C<gsl_cheb_alloc($size)>
  56
  57     my $cheb = gsl_cheb_alloc(50);
  58
  59 Allocates a new Chebyshev object with $size sample points.
  60
  61 =item * C<gsl_cheb_free($cheb)>
  62
  63 Deallocates memory associated to $cheb. Returns void.
  64
  65 =item * C<gsl_cheb_init($cheb,$function, $lower, $upper)>
  66
  67     gsl_cheb_init($cheb, sub { sin(cos($_[0])) }, 0, 10 );
  68
  69 Initiate a Chebyshev object with a function and upper and lower bounds.
  70 Returns void.
  71
  72 =item * C<gsl_cheb_eval($function, $value)>
  73
  74     my $evaluated = gsl_cheb_eval($cheb, 5 );
  75
  76 Returns a Perl scalar of the Chebyshev object $cheb evaluated at $value.
  77
  78 =item * C<gsl_cheb_eval_err($cheb, $value)>
  79
  80     my ($status,$evaluated,$err) = gsl_cheb_eval($cheb, 5 );
  81
  82 Returns a list consisting of a GSL status code, the evaluate value and
  83 the estimated error of the evaluation.
  84
  85 =item * C<gsl_cheb_eval_n >
  86
  87 =item * C<gsl_cheb_eval_n_err >
  88
  89 =item * C<gsl_cheb_eval_mode >
  90
  91 =item * C<gsl_cheb_eval_mode_e >
  92
  93 =item * C<gsl_cheb_calc_deriv($deriv,$cheb) >
  94
  95    my $status = gsl_cheb_calc_deriv( $deriv, $cheb );
  96
  97 This will calculate the derivative of $cheb and stores it
  98 in $deriv, which must be pre-allocated. Returns a GSL status code.
  99
 100 =item * C<gsl_cheb_calc_integ($integ,$cheb) >
 101
 102    my $status = gsl_cheb_calc_integ( $deriv, $cheb );
 103
 104 This will calculate the derivative of $cheb and stores it
 105 in $deriv, which must be pre-allocated. Returns a GSL status code.
 106
 107 =back
 108
 109 For more informations on the functions, we refer you to the GSL offcial
 110 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
 111
 112  Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
 113
 114
 115 =head1 AUTHORS
 116
 117 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 118
 119 =head1 COPYRIGHT AND LICENSE
 120
 121 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 122
 123 This program is free software; you can redistribute it and/or modify it
 124 under the same terms as Perl itself.
 125
 126 =cut
 127
 128 %}