Comment out some more free() calls, which need to be turned on per-subsystem to weed...
[Math-GSL.git] / pod / Sys.pod
blobccd57f4352bba5f92745533234fae3fc967a720f
1 %perlcode %{
2 our @EXPORT = qw();
3 our @EXPORT_OK = qw/
4                gsl_log1p
5                gsl_expm1
6                gsl_hypot
7                gsl_hypot3
8                gsl_acosh
9                gsl_asinh
10                gsl_atanh
11                gsl_isnan
12                gsl_isinf
13                gsl_finite
14                gsl_posinf
15                gsl_neginf
16                gsl_fdiv
17                gsl_coerce_double
18                gsl_coerce_float
19                gsl_coerce_long_double
20                gsl_ldexp
21                gsl_frexp
22                gsl_fcmp
23                gsl_nan
24                gsl_isnan
25                gsl_inf
26                $GSL_NAN
27                $GSL_POSINF
28                $GSL_NEGINF
29              /;
31 our %EXPORT_TAGS = ( all => \@EXPORT_OK );
32 our $GSL_NAN    = gsl_nan();
33 our $GSL_POSINF = gsl_posinf();
34 our $GSL_NEGINF = gsl_neginf();
36 __END__
38 =head1 NAME
40 Math::GSL::Sys -
42 =head1 SYNOPSIS
44 use Math::GSL::Sys qw /:all/;
46 =head1 DESCRIPTION
48 Here is a list of all the functions in this module :
50 =over
52 =item * C<gsl_log1p($x)> - This function computes the value of \log(1+$x) in a way that is accurate for small $x. It provides an alternative to the BSD math function log1p(x).
53 =item * C<gsl_expm1($x)> - This function computes the value of \exp($x)-1 in a way that is accurate for small $x. It provides an alternative to the BSD math function expm1(x).
55 =item * C<gsl_hypot($x, $y)> - This function computes the value of \sqrt{$x^2 + $y^2} in a way that avoids overflow. It provides an alternative to the BSD math function hypot($x,$y).
57 =item * C<gsl_hypot3($x, $y, $z)> - This function computes the value of \sqrt{$x^2 + $y^2 + $z^2} in a way that avoids overflow.
59 =item * C<gsl_acosh($x)> - This function computes the value of \arccosh($x). It provides an alternative to the standard math function acosh($x).
61 =item * C<gsl_asinh($x)> - This function computes the value of \arcsinh($x). It provides an alternative to the standard math function asinh($x).
63 =item * C<gsl_atanh($x)> - This function computes the value of \arctanh($x). It provides an alternative to the standard math function atanh($x).
65 =item * C<gsl_isnan($x)> - This function returns 1 if $x is not-a-number.
67 =item * C<gsl_isinf($x)> - This function returns +1 if $x is positive infinity, -1 if $x is negative infinity and 0 otherwise.
69 =item * C<gsl_finite($x)> - This function returns 1 if $x is a real number, and 0 if it is infinite or not-a-number.
71 =item * C<gsl_posinf >
73 =item * C<gsl_neginf >
75 =item * C<gsl_fdiv >
77 =item * C<gsl_coerce_double >
79 =item * C<gsl_coerce_float >
81 =item * C<gsl_coerce_long_double >
83 =item * C<gsl_ldexp($x, $e)> - This function computes the value of $x * 2**$e. It provides an alternative to the standard math function ldexp($x,$e).
85 =item * C<gsl_frexp($x)> - This function splits the number $x into its normalized fraction f and exponent e, such that $x = f * 2^e and 0.5 <= f < 1. The function returns f and then the exponent in e. If $x is zero, both f and e are set to zero. This function provides an alternative to the standard math function frexp(x, e).
87 =item * C<gsl_fcmp($x, $y, $epsilon)> - This function determines whether $x and $y are approximately equal to a relative accuracy $epsilon. The relative accuracy is measured using an interval of size 2 \delta, where \delta = 2^k \epsilon and k is the maximum base-2 exponent of $x and $y as computed by the function frexp. If $x and $y lie within this interval, they are considered approximately equal and the function returns 0. Otherwise if $x < $y, the function returns -1, or if $x > $y, the function returns +1. Note that $x and $y are compared to relative accuracy, so this function is not suitable for testing whether a value is approximately zero. The implementation is based on the package fcmp by T.C. Belding.
89 =back
91 For more informations on the functions, we refer you to the GSL offcial
92 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
94  Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
97 =head1 AUTHORS
99 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
101 =head1 COPYRIGHT AND LICENSE
103 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
105 This program is free software; you can redistribute it and/or modify it
106 under the same terms as Perl itself.
108 =cut