Multiroots.i

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