Apply nan/inf handling patch from Sisyphus
[Math-GSL.git] / Min.i
blobcc7f3b6e5b003f8d140b9f68b1271432c50cadc1
1 %module "Math::GSL::Min"
2 %{
3 #include "gsl/gsl_types.h"
4 #include "gsl/gsl_min.h"
5 %}
7 %include "gsl/gsl_types.h"
8 %include "gsl/gsl_min.h"
10 %perlcode %{
12 @EXPORT_OK = qw/
13 gsl_min_fminimizer_alloc
14 gsl_min_fminimizer_free
15 gsl_min_fminimizer_set
16 gsl_min_fminimizer_set_with_values
17 gsl_min_fminimizer_iterate
18 gsl_min_fminimizer_name
19 gsl_min_fminimizer_x_minimum
20 gsl_min_fminimizer_x_lower
21 gsl_min_fminimizer_x_upper
22 gsl_min_fminimizer_f_minimum
23 gsl_min_fminimizer_f_lower
24 gsl_min_fminimizer_f_upper
25 gsl_min_fminimizer_minimum
26 gsl_min_test_interval
27 gsl_min_find_bracket
28 $gsl_min_fminimizer_brent
29 $gsl_min_fminimizer_goldensection
32 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
34 __END__
36 =head1 NAME
38 Math::GSL::Min - Routines for finding minima of arbitrary one-dimensional functions
40 =head1 SYNOPSIS
42 This module is not yet implemented. Patches Welcome!
44 use Math::GSL::Min qw /:all/;
46 =head1 DESCRIPTION
48 Here is a list of all the functions in this module :
50 =over
52 =item * C<gsl_min_fminimizer_alloc >
54 =item * C<gsl_min_fminimizer_free >
56 =item * C<gsl_min_fminimizer_set >
58 =item * C<gsl_min_fminimizer_set_with_values>
60 =item * C<gsl_min_fminimizer_iterate >
62 =item * C<gsl_min_fminimizer_name >
64 =item * C<gsl_min_fminimizer_x_minimum>
66 =item * C<gsl_min_fminimizer_x_lower >
68 =item * C<gsl_min_fminimizer_x_upper >
70 =item * C<gsl_min_fminimizer_f_minimum>
72 =item * C<gsl_min_fminimizer_f_lower >
74 =item * C<gsl_min_fminimizer_f_upper >
76 =item * C<gsl_min_fminimizer_minimum >
78 =item * C<gsl_min_test_interval >
80 =item * C<gsl_min_find_bracket >
82 =back
84 This module also includes the following constants :
86 =over
88 =item * C<$gsl_min_fminimizer_brent>
90 =item * C<$gsl_min_fminimizer_goldensection>
92 =back
94 For more informations on the functions, we refer you to the GSL offcial
95 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
97 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
100 =head1 AUTHORS
102 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
104 =head1 COPYRIGHT AND LICENSE
106 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
108 This program is free software; you can redistribute it and/or modify it
109 under the same terms as Perl itself.
111 =cut