pod/Multimin.pod

   1 %perlcode %{
   2
   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
  28 /;
  29
  30 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  31
  32 __END__
  33
  34 =head1 NAME
  35
  36 Math::GSL::Multimin - Routines for finding minima of arbitrary multidimensional functions
  37
  38 =head1 SYNOPSIS
  39
  40 This module is not yet implemented. Patches Welcome!
  41
  42 use Math::GSL::Multimin qw /:all/;
  43
  44 =head1 DESCRIPTION
  45
  46 Here is a list of all the functions in this module :
  47
  48 =over
  49
  50 =item * C<gsl_multimin_fdfminimizer_alloc>
  51
  52 =item * C<gsl_multimin_fminimizer_alloc>
  53
  54 =item * C<gsl_multimin_fdfminimizer_set>
  55
  56 =item * C<gsl_multimin_fdfminimizer_free>
  57
  58 =item * C<gsl_multimin_fminimizer_free>
  59
  60 =item * C<gsl_multimin_fdfminimizer_name>
  61
  62 =item * C<gsl_multimin_fminimizer_name>
  63
  64 =item * C<gsl_multimin_fdfminimizer_iterate>
  65
  66 =item * C<gsl_multimin_fminimizer_iterate>
  67
  68 =item * C<gsl_multimin_fdfminimizer_x>
  69
  70 =item * C<gsl_multimin_fminimizer_x>
  71
  72 =item * C<gsl_multimin_fdfminimizer_minimum>
  73
  74 =item * C<gsl_multimin_fminimizer_minimum>
  75
  76 =item * C<gsl_multimin_fdfminimizer_gradient>
  77
  78 =item * C<gsl_multimin_fminimizer_size>
  79
  80 =item * C<gsl_multimin_fdfminimizer_restart>
  81
  82 =item * C<gsl_multimin_test_gradient>
  83
  84 =item * C<gsl_multimin_test_size>
  85
  86 =back
  87
  88 This module also includes the following constants :
  89
  90 =over
  91
  92 =item * C<$gsl_multimin_fdfminimizer_conjugate_fr>
  93
  94 =item * C<$gsl_multimin_fdfminimizer_conjugate_pr>
  95
  96 =item * C<$gsl_multimin_fdfminimizer_vector_bfgs2>
  97
  98 =item * C<$gsl_multimin_fdfminimizer_vector_bfgs>
  99
 100 =item * C<$gsl_multimin_fdfminimizer_steepest_descent>
 101
 102 =item * C<$gsl_multimin_fminimizer_nmsimplex>
 103
 104 =back
 105
 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/>
 108
 109 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
 110
 111
 112 =head1 AUTHORS
 113
 114 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 115
 116 =head1 COPYRIGHT AND LICENSE
 117
 118 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
 119
 120 This program is free software; you can redistribute it and/or modify it
 121 under the same terms as Perl itself.
 122
 123 =cut
 124
 125 %}
 126