pod/Chebyshev.pod

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