Roots.i

   1 %module "Math::GSL::Roots"
   2 %{
   3     #include "gsl/gsl_types.h"
   4     #include "gsl/gsl_roots.h"
   5 %}
   6 %include "gsl/gsl_types.h"
   7 %include "gsl/gsl_roots.h"
   8
   9
  10 %perlcode %{
  11 @EXPORT_OK = qw/
  12                gsl_root_fsolver_alloc
  13                gsl_root_fsolver_free
  14                gsl_root_fsolver_set
  15                gsl_root_fsolver_iterate
  16                gsl_root_fsolver_name
  17                gsl_root_fsolver_root
  18                gsl_root_fsolver_x_lower
  19                gsl_root_fsolver_x_upper
  20                gsl_root_fdfsolver_alloc
  21                gsl_root_fdfsolver_set
  22                gsl_root_fdfsolver_iterate
  23                gsl_root_fdfsolver_free
  24                gsl_root_fdfsolver_name
  25                gsl_root_fdfsolver_root
  26                gsl_root_test_interval
  27                gsl_root_test_residual
  28                gsl_root_test_delta
  29                $gsl_root_fsolver_bisection
  30                $gsl_root_fsolver_brent
  31                $gsl_root_fsolver_falsepos
  32                $gsl_root_fdfsolver_newton
  33                $gsl_root_fdfsolver_secant
  34                $gsl_root_fdfsolver_steffenson
  35              /;
  36 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  37
  38 __END__
  39
  40 =head1 NAME
  41
  42 Math::GSL::Roots - Routines for finding roots of arbitrary one-dimensional functions.
  43
  44 =head1 SYNOPSIS
  45
  46 This module is not yet implemented. Patches Welcome!
  47
  48 use Math::GSL::Roots qw /:all/;
  49
  50 =head1 DESCRIPTION
  51
  52 Here is a list of all the functions in this module :
  53
  54 =over
  55
  56 =item * C<gsl_root_fsolver_alloc >
  57
  58 =item * C<gsl_root_fsolver_free >
  59
  60 =item * C<gsl_root_fsolver_set >
  61
  62 =item * C<gsl_root_fsolver_iterate >
  63
  64 =item * C<gsl_root_fsolver_name >
  65
  66 =item * C<gsl_root_fsolver_root >
  67
  68 =item * C<gsl_root_fsolver_x_lower >
  69
  70 =item * C<gsl_root_fsolver_x_upper >
  71
  72 =item * C<gsl_root_fdfsolver_alloc >
  73
  74 =item * C<gsl_root_fdfsolver_set >
  75
  76 =item * C<gsl_root_fdfsolver_iterate >
  77
  78 =item * C<gsl_root_fdfsolver_free >
  79
  80 =item * C<gsl_root_fdfsolver_name >
  81
  82 =item * C<gsl_root_fdfsolver_root >
  83
  84 =item * C<gsl_root_test_interval >
  85
  86 =item * C<gsl_root_test_residual >
  87
  88 =item * C<gsl_root_test_delta >
  89
  90 =back
  91
  92 This module also includes the following constants :
  93
  94 =over
  95
  96 =item * C<$gsl_root_fsolver_bisection>
  97
  98 =item * C<$gsl_root_fsolver_brent>
  99
 100 =item * C<$gsl_root_fsolver_falsepos>
 101
 102 =item * C<$gsl_root_fdfsolver_newton>
 103
 104 =item * C<$gsl_root_fdfsolver_secant>
 105
 106 =item * C<$gsl_root_fdfsolver_steffenson>
 107
 108 =back
 109
 110 For more informations on the functions, we refer you to the GSL offcial
 111 documentation: L<http://www.gnu.org/software/gsl/manual/html_node/>
 112
 113  Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
 114
 115
 116 =head1 AUTHORS
 117
 118 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
 119
 120 =head1 COPYRIGHT AND LICENSE
 121
 122 Copyright (C) 2008 Jonathan Leto and Thierry Moisan
 123
 124 This program is free software; you can redistribute it and/or modify it
 125 under the same terms as Perl itself.
 126
 127 =cut
 128
 129 %}