pod/Poly.pod

   1 %perlcode %{
   2
   3 @EXPORT_OK = qw/
   4                 gsl_poly_eval
   5                 gsl_poly_complex_eval
   6                 gsl_complex_poly_complex_eval
   7                 gsl_poly_dd_init
   8                 gsl_poly_dd_eval
   9                 gsl_poly_dd_taylor
  10                 gsl_poly_solve_quadratic
  11                 gsl_poly_complex_solve_quadratic
  12                 gsl_poly_solve_cubic
  13                 gsl_poly_complex_solve_cubic
  14                 gsl_poly_complex_workspace_alloc
  15                 gsl_poly_complex_workspace_free
  16                 gsl_poly_complex_solve
  17                 $GSL_POSZERO $GSL_NEGZERO $GSL_NAN
  18              /;
  19
  20 %EXPORT_TAGS = ( all => \@EXPORT_OK );
  21
  22 __END__
  23
  24 =head1 NAME
  25
  26 Math::GSL::Poly - Functions for evaluating and solving polynomials
  27
  28 =head1 SYNOPSIS
  29
  30 use Math::GSL::Poly qw/:all/;
  31
  32 =head1 DESCRIPTION
  33
  34 Here is a list of all the functions included in this module :
  35
  36 =over
  37
  38 =item * gsl_poly_eval(@values, $length, $x) - This function evaluates a polynomial with real coefficients for the real variable $x. $length is the number of elements inside @values. The function returns a complex number.
  39
  40 =item * gsl_poly_complex_eval(@values, $length, $z) - This function evaluates a polynomial with real coefficients for the complex variable $z. $length is the number of elements inside @valuesi. The function returns a complex number.
  41
  42 =item * gsl_complex_poly_complex_eval(@values, $length, $z) - This function evaluates a polynomial with real coefficients for the complex variable $z. $length is the number of elements inside @values. $length is the number of elements inside @values. The function returns a complex number.
  43
  44 =item * gsl_poly_dd_init
  45
  46 =item * gsl_poly_dd_eval
  47
  48 =item * gsl_poly_dd_taylor
  49
  50 =item * gsl_poly_solve_quadratic( $a, $b, $c, \$x0, \$x1) - find the real roots of the quadratic equation $a*x**2+$b*x+$c = 0, return the number of real root (either zero, one or two) and the real roots are returned by $x0, $x1 and $x2 which are deferenced.
  51
  52 =item * gsl_poly_complex_solve_quadratic
  53
  54 =item * gsl_poly_solve_cubic($a, $b, $c, \$x0, \$x1, \$x2) - find the real roots of the cubic equation x**3+$a*x**2+$b*x+$c = 0, return the number of real root (either one or three) and the real roots are returned by $x0, $x1 and $x2 which are deferenced.
  55
  56 =item * gsl_poly_complex_solve_cubic
  57
  58 =item * gsl_poly_complex_workspace_alloc($n) - This function allocates space for a gsl_poly_complex_workspace struct and a workspace suitable for solving a polynomial with $n coefficients using the routine gsl_poly_complex_solve.
  59
  60 =item * gsl_poly_complex_workspace_free($w) - This function frees all the memory associated with the workspace w.
  61
  62 =item * gsl_poly_complex_solve
  63
  64 =back
  65
  66 For more informations on the functions, we refer you to the GSL offcial documentation:
  67 L<http://www.gnu.org/software/gsl/manual/html_node/>
  68
  69 Tip : search on google: site:http://www.gnu.org/software/gsl/manual/html_node/ name_of_the_function_you_want
  70
  71 =head1 EXAMPLES
  72
  73 =over 1
  74
  75 =item C<use Math::GSL::Poly qw/:all/;>
  76
  77 =item C<my ($a,$b,$c) = (1,6,9);>
  78
  79 =item C<my ($x0, $x1) = (0,0);>
  80
  81 =item C<my $num_roots = gsl_poly_solve_quadratic( $a, $b, $c, \$x0, \$x1);>
  82
  83 =item C<print "${a}*x**2 + ${b}*x + $c contains $num_roots roots which are $x0 and $x1. \n";>
  84
  85 =back
  86
  87 =head1 AUTHORS
  88
  89 Jonathan Leto <jonathan@leto.net> and Thierry Moisan <thierry.moisan@gmail.com>
  90
  91 =head1 COPYRIGHT AND LICENSE
  92
  93 Copyright (C) 2008-2009 Jonathan Leto and Thierry Moisan
  94
  95 This program is free software; you can redistribute it and/or modify it
  96 under the same terms as Perl itself.
  97
  98 =cut
  99 %}
 100
 101