Multimin.i

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