File: Diff.pod

package info (click to toggle)
libmath-gsl-perl 0.45-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 192,156 kB
  • sloc: ansic: 895,524; perl: 24,682; makefile: 12
file content (73 lines) | stat: -rw-r--r-- 1,790 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
%perlcode %{
@EXPORT_OK = qw/
               gsl_diff_central
               gsl_diff_backward
               gsl_diff_forward
             /;
%EXPORT_TAGS = ( all => [ @EXPORT_OK ] );

__END__

=encoding utf8

=head1 NAME

Math::GSL::Diff - Numerical differentiation routines

=head1 SYNOPSIS

    use Math::GSL::Diff qw/:all/;

=head1 DESCRIPTION

Here is a list of all the functions included in this module :

=over

=item C<gsl_diff_central>

This function computes the numerical derivative of the function f
at the point x using an adaptive central difference algorithm.
The result is an array where the first position is an error code (0 for success),
the second is derivative value, and the third is an estimate of its absolute error.

   my ($success, $result, $error) =
         gsl_diff_central(sub { return $_[0] ** 1.5 }, 2.0);

=item C<gsl_diff_backward>

This function computes the numerical derivative of the function f 
at the point x using an adaptive forward difference algorithm.
Its usage is similar to C<gsl_diff_central>.

   my ($success, $result, $error) =
          gsl_diff_backward(sub { return $_[0] ** 1.5 }, 0.0);


=item C<gsl_diff_forward>

This function computes the numerical derivative of the
function f at the point x using an adaptive backward difference algorithm.
Its usage is similar to C<gsl_diff_central>.

   my ($success, $result, $error) =
          gsl_diff_forward(sub { return $_[0] ** 1.5 }, 1.0);


=back

=head1 EXAMPLES

=head1 AUTHORS

Jonathan "Duke" Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2008-2024 Jonathan "Duke" Leto and Thierry Moisan

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut
%}