version bump
[Math-GSL.git] / Multimin.i
blob1b05c4a0bd070570c03005792423c00dc0417418
1 %module "Math::GSL::Multimin"
3 %{
4 #include "gsl/gsl_types.h"
5 #include "gsl/gsl_multimin.h"
6 %}
8 %include "gsl/gsl_types.h"
9 %include "gsl/gsl_multimin.h"
11 %perlcode %{
13 @EXPORT_OK = qw/
14 gsl_multimin_fdfminimizer_alloc
15 gsl_multimin_fminimizer_alloc
16 gsl_multimin_fdfminimizer_set
17 gsl_multimin_fdfminimizer_free
18 gsl_multimin_fminimizer_free
19 gsl_multimin_fdfminimizer_name
20 gsl_multimin_fminimizer_name
21 gsl_multimin_fdfminimizer_iterate
22 gsl_multimin_fminimizer_iterate
23 gsl_multimin_fdfminimizer_x
24 gsl_multimin_fminimizer_x
25 gsl_multimin_fdfminimizer_minimum
26 gsl_multimin_fminimizer_minimum
27 gsl_multimin_fdfminimizer_gradient
28 gsl_multimin_fminimizer_size
29 gsl_multimin_fdfminimizer_restart
30 gsl_multimin_test_gradient
31 gsl_multimin_test_size
32 $gsl_multimin_fdfminimizer_conjugate_fr
33 $gsl_multimin_fdfminimizer_conjugate_pr
34 $gsl_multimin_fdfminimizer_vector_bfgs2
35 $gsl_multimin_fdfminimizer_vector_bfgs
36 $gsl_multimin_fdfminimizer_steepest_descent
37 $gsl_multimin_fminimizer_nmsimplex
40 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
42 __END__
44 =head1 NAME
46 Math::GSL::Multimin - Routines for finding minima of arbitrary multidimensional functions
48 =head1 SYNOPSIS
50 This module is not yet implemented. Patches Welcome!
52 use Math::GSL::Multimin qw /:all/;
54 =head1 DESCRIPTION
56 Here is a list of all the functions in this module :
58 =over
60 =item * C<gsl_multimin_fdfminimizer_alloc>
62 =item * C<gsl_multimin_fminimizer_alloc>
64 =item * C<gsl_multimin_fdfminimizer_set>
66 =item * C<gsl_multimin_fdfminimizer_free>
68 =item * C<gsl_multimin_fminimizer_free>
70 =item * C<gsl_multimin_fdfminimizer_name>
72 =item * C<gsl_multimin_fminimizer_name>
74 =item * C<gsl_multimin_fdfminimizer_iterate>
76 =item * C<gsl_multimin_fminimizer_iterate>
78 =item * C<gsl_multimin_fdfminimizer_x>
80 =item * C<gsl_multimin_fminimizer_x>
82 =item * C<gsl_multimin_fdfminimizer_minimum>
84 =item * C<gsl_multimin_fminimizer_minimum>
86 =item * C<gsl_multimin_fdfminimizer_gradient>
88 =item * C<gsl_multimin_fminimizer_size>
90 =item * C<gsl_multimin_fdfminimizer_restart>
92 =item * C<gsl_multimin_test_gradient>
94 =item * C<gsl_multimin_test_size>
96 =back
98 This module also includes the following constants :
100 =over
102 =item * C<$gsl_multimin_fdfminimizer_conjugate_fr>
104 =item * C<$gsl_multimin_fdfminimizer_conjugate_pr>
106 =item * C<$gsl_multimin_fdfminimizer_vector_bfgs2>
108 =item * C<$gsl_multimin_fdfminimizer_vector_bfgs>
110 =item * C<$gsl_multimin_fdfminimizer_steepest_descent>
112 =item * C<$gsl_multimin_fminimizer_nmsimplex>
114 =back
116 For more informations on the functions, we refer you to the GSL offcial
117 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
119 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
122 =head1 AUTHORS
124 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
126 =head1 COPYRIGHT AND LICENSE
128 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
130 This program is free software; you can redistribute it and/or modify it
131 under the same terms as Perl itself.
133 =cut