POD for Math::GSL::Test
[Math-GSL.git] / Min.i
blobaae7f1f5528a2ff6058b65bd38f9bc0ba69dd87c
1 %module "Math::GSL::Min"
2 %include "typemaps.i"
3 %include "gsl_typemaps.i"
4 %{
5 #include "gsl/gsl_types.h"
6 #include "gsl/gsl_min.h"
7 #include "gsl/gsl_math.h"
8 %}
9 %include "gsl/gsl_types.h"
10 %include "gsl/gsl_min.h"
11 %include "gsl/gsl_math.h"
13 %perlcode %{
15 @EXPORT_OK = qw/
16 gsl_min_fminimizer_alloc
17 gsl_min_fminimizer_free
18 gsl_min_fminimizer_set
19 gsl_min_fminimizer_set_with_values
20 gsl_min_fminimizer_iterate
21 gsl_min_fminimizer_name
22 gsl_min_fminimizer_x_minimum
23 gsl_min_fminimizer_x_lower
24 gsl_min_fminimizer_x_upper
25 gsl_min_fminimizer_f_minimum
26 gsl_min_fminimizer_f_lower
27 gsl_min_fminimizer_f_upper
28 gsl_min_fminimizer_minimum
29 gsl_min_test_interval
30 gsl_min_find_bracket
31 $gsl_min_fminimizer_brent
32 $gsl_min_fminimizer_goldensection
35 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
37 __END__
39 =head1 NAME
41 Math::GSL::Min - One-dimensional Minimization
43 =head1 SYNOPSIS
45 This module is not yet implemented. Patches Welcome!
47 use Math::GSL::Min qw /:all/;
49 =head1 DESCRIPTION
51 Here is a list of all the functions in this module :
53 =over
55 =item * C<gsl_min_fminimizer_alloc >
57 =item * C<gsl_min_fminimizer_free >
59 =item * C<gsl_min_fminimizer_set >
61 =item * C<gsl_min_fminimizer_set_with_values>
63 =item * C<gsl_min_fminimizer_iterate >
65 =item * C<gsl_min_fminimizer_name >
67 =item * C<gsl_min_fminimizer_x_minimum>
69 =item * C<gsl_min_fminimizer_x_lower >
71 =item * C<gsl_min_fminimizer_x_upper >
73 =item * C<gsl_min_fminimizer_f_minimum>
75 =item * C<gsl_min_fminimizer_f_lower >
77 =item * C<gsl_min_fminimizer_f_upper >
79 =item * C<gsl_min_fminimizer_minimum >
81 =item * C<gsl_min_test_interval >
83 =item * C<gsl_min_find_bracket >
85 =back
87 This module also includes the following constants :
89 =over
91 =item * C<$gsl_min_fminimizer_brent>
93 =item * C<$gsl_min_fminimizer_goldensection>
95 =back
97 For more informations on the functions, we refer you to the GSL offcial
98 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
100 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
103 =head1 AUTHORS
105 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
107 =head1 COPYRIGHT AND LICENSE
109 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
111 This program is free software; you can redistribute it and/or modify it
112 under the same terms as Perl itself.
114 =cut