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