=head1 NAME
PerlGSL::RootFinding::SingleDim - A Perlish Interface to the GSL 1D Root Finding Library
=head1 SYNOPSIS
use PerlGSL::Integration::SingleDim qw/findroot_1d/;
my $result = findroot_1d(sub{ $_[0]**2 - 5 }, 0, 5); # sqrt(5)
=head1 DESCRIPTION
This module is an interface to the GSL's Single Dimensional numerical root finding routines. So far only the "bracketing" Brent-Dekker method is implemented.
=head1 FUNCTIONS
No functions are exported by default.
=over 4
=item findroot_1d
This is the main interface provided by the module. It takes three required arguments and an (optional) options hash. The first argument is a subroutine reference defining the function. The next two are numbers defining the lower and upper bound for searching.
The options hash reference accepts the following keys:
=over 4
=item *
epsabs - The maximum allowable absolute error. The default is C<0> (ignored).
=item *
epsrel - The maximum allowable relative error. The default is C<1e-4>.
=item *
max_iter - The maximum number of search iterations permitted. The default is 1000.
=back
The return value is the position of the root. Note that if there are multiple roots in the search location only one will be returned; there is no way to tell which it will be.
=back
=head1 INSTALLATION REQUIREMENTS
This module needs the GSL library installed and available. The C environment variable may be used to pass the C<--libs> linker flags; if this is not specified, the command C is executed to find them. Future plans include using an L module to provide the GSL in a more CPAN-friendly manner.
=head1 FUTURE WORK
Derivative methods may be added, but would require a separate closure representing the derivative of the function (unless numeric derivatives were employed). This makes such mechanisms less useful at least for now, of course, L!
=head1 SEE ALSO
=over 4
=item *
L
=item *
L
=back
=head1 SOURCE REPOSITORY
L
=head1 AUTHOR
Joel Berger, Ejoel.a.berger@gmail.comE
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2012 by Joel Berger
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
The GSL is licensed under the terms of the GNU General Public License (GPL)