Multiroots.i

   1 %module "Math::GSL::Multiroots"
   2 %include "gsl_typemaps.i"
   3
   4 %typemap(in) gsl_multiroot_function * {
   5     gsl_multiroot_function *f;
   6     /* stub */
   7     $1 = &f;
   8 }
   9
  10 %{
  11     #include "gsl/gsl_types.h"
  12     #include "gsl/gsl_multiroots.h"
  13 %}
  14
  15 %include "gsl/gsl_types.h"
  16 %include "gsl/gsl_multiroots.h"
  17
  18
  19 %perlcode %{
  20 @EXPORT_OK = qw/
  21                gsl_multiroot_fdjacobian
  22                gsl_multiroot_fsolver_alloc
  23                gsl_multiroot_fsolver_free
  24                gsl_multiroot_fsolver_set
  25                gsl_multiroot_fsolver_iterate
  26                gsl_multiroot_fsolver_name
  27                gsl_multiroot_fsolver_root
  28                gsl_multiroot_fsolver_dx
  29                gsl_multiroot_fsolver_f
  30                gsl_multiroot_fdfsolver_alloc
  31                gsl_multiroot_fdfsolver_set
  32                gsl_multiroot_fdfsolver_iterate
  33                gsl_multiroot_fdfsolver_free
  34                gsl_multiroot_fdfsolver_name
  35                gsl_multiroot_fdfsolver_root
  36                gsl_multiroot_fdfsolver_dx
  37                gsl_multiroot_fdfsolver_f
  38                gsl_multiroot_test_delta
  39                gsl_multiroot_test_residual
  40                $gsl_multiroot_fsolver_dnewton
  41                $gsl_multiroot_fsolver_broyden
  42                $gsl_multiroot_fsolver_hybrid
  43                $gsl_multiroot_fsolver_hybrids
  44                $gsl_multiroot_fdfsolver_newton
  45                $gsl_multiroot_fdfsolver_gnewton
  46                $gsl_multiroot_fdfsolver_hybridj
  47                $gsl_multiroot_fdfsolver_hybridsj
  48              /;
  49 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  50
  51 __END__
  52
  53 =head1 NAME
  54
  55 Math::GSL::Multiroots -Functions for multidimensional root-finding (solving nonlinear systems with n equations in n unknowns).
  56
  57 =head1 SYNOPSIS
  58
  59 This module is not yet implemented. Patches Welcome!
  60
  61 use Math::GSL::Multiroots qw /:all/;
  62
  63 =head1 DESCRIPTION
  64
  65 Here is a list of all the functions in this module :
  66
  67 =over
  68
  69 =item * C<gsl_multiroot_fdjacobian >
  70
  71 =item * C<gsl_multiroot_fsolver_alloc >
  72
  73 =item * C<gsl_multiroot_fsolver_free >
  74
  75 =item * C<gsl_multiroot_fsolver_set >
  76
  77 =item * C<gsl_multiroot_fsolver_iterate >
  78
  79 =item * C<gsl_multiroot_fsolver_name >
  80
  81 =item * C<gsl_multiroot_fsolver_root >
  82
  83 =item * C<gsl_multiroot_fsolver_dx >
  84
  85 =item * C<gsl_multiroot_fsolver_f >
  86
  87 =item * C<gsl_multiroot_fdfsolver_alloc >
  88
  89 =item * C<gsl_multiroot_fdfsolver_set >
  90
  91 =item * C<gsl_multiroot_fdfsolver_iterate >
  92
  93 =item * C<gsl_multiroot_fdfsolver_free >
  94
  95 =item * C<gsl_multiroot_fdfsolver_name >
  96
  97 =item * C<gsl_multiroot_fdfsolver_root >
  98
  99 =item * C<gsl_multiroot_fdfsolver_dx >
 100
 101 =item * C<gsl_multiroot_fdfsolver_f >
 102
 103 =item * C<gsl_multiroot_test_delta >
 104
 105 =item * C<gsl_multiroot_test_residual >
 106
 107 =back
 108
 109 For more informations on the functions, we refer you to the GSL offcial
 110 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
 111
 112 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
 113
 114
 115 =head1 AUTHORS
 116
 117 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 118
 119 =head1 COPYRIGHT AND LICENSE
 120
 121 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 122
 123 This program is free software; you can redistribute it and/or modify it
 124 under the same terms as Perl itself.
 125
 126 =cut
 127
 128 %}