Bump minor revision again, prepping for CPAN test release
[Math-GSL.git] / pod / Min.pod
blob8b191fc260f9f39c07479caa8d15587df9fe6f9d
1 %perlcode %{
3 @EXPORT_OK = qw/
4    gsl_min_fminimizer_alloc 
5    gsl_min_fminimizer_free 
6    gsl_min_fminimizer_set 
7    gsl_min_fminimizer_set_with_values
8    gsl_min_fminimizer_iterate 
9    gsl_min_fminimizer_name 
10    gsl_min_fminimizer_x_minimum
11    gsl_min_fminimizer_x_lower 
12    gsl_min_fminimizer_x_upper 
13    gsl_min_fminimizer_f_minimum
14    gsl_min_fminimizer_f_lower 
15    gsl_min_fminimizer_f_upper 
16    gsl_min_fminimizer_minimum 
17    gsl_min_test_interval 
18    gsl_min_find_bracket 
19    $gsl_min_fminimizer_brent
20    $gsl_min_fminimizer_goldensection
23 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
25 __END__
27 =head1 NAME
29 Math::GSL::Min - One-dimensional Minimization
31 =head1 SYNOPSIS
33 This module is not yet implemented. Patches Welcome!
35 use Math::GSL::Min qw /:all/;
37 =head1 DESCRIPTION
39 Here is a list of all the functions in this module :
41 =over
43 =item * C<gsl_min_fminimizer_alloc >
45 =item * C<gsl_min_fminimizer_free >
47 =item * C<gsl_min_fminimizer_set >
49 =item * C<gsl_min_fminimizer_set_with_values>
51 =item * C<gsl_min_fminimizer_iterate >
53 =item * C<gsl_min_fminimizer_name >
55 =item * C<gsl_min_fminimizer_x_minimum>
57 =item * C<gsl_min_fminimizer_x_lower >
59 =item * C<gsl_min_fminimizer_x_upper >
61 =item * C<gsl_min_fminimizer_f_minimum>
63 =item * C<gsl_min_fminimizer_f_lower >
65 =item * C<gsl_min_fminimizer_f_upper >
67 =item * C<gsl_min_fminimizer_minimum >
69 =item * C<gsl_min_test_interval >
71 =item * C<gsl_min_find_bracket >
73 =back
75 This module also includes the following constants :
77 =over
79 =item * C<$gsl_min_fminimizer_brent>
81 =item * C<$gsl_min_fminimizer_goldensection> 
83 =back
85 For more informations on the functions, we refer you to the GSL offcial
86 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
88  Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
91 =head1 AUTHORS
93 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
95 =head1 COPYRIGHT AND LICENSE
97 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
99 This program is free software; you can redistribute it and/or modify it
100 under the same terms as Perl itself.
102 =cut