From dcb0ba9403684d1e43442347c27f7bc75281f1dc Mon Sep 17 00:00:00 2001 From: Thierry Moisan Date: Thu, 31 Jul 2008 15:32:17 -0400 Subject: [PATCH] Adding =item markers to Poly --- Poly.i | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/Poly.i b/Poly.i index ea9839f..8621630 100644 --- a/Poly.i +++ b/Poly.i @@ -115,33 +115,37 @@ use Math::GSL::Poly qw/:all/; =head1 DESCRIPTION - Here is a list of all the functions included in this module : +Here is a list of all the functions included in this module : - 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. +=over - 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. +=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. - 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. +=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. - gsl_poly_dd_init +=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. - gsl_poly_dd_eval +=item * gsl_poly_dd_init - gsl_poly_dd_taylor +=item * gsl_poly_dd_eval - 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. +=item * gsl_poly_dd_taylor - gsl_poly_complex_solve_quadratic +=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. - 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. +=item * gsl_poly_complex_solve_quadratic - gsl_poly_complex_solve_cubic +=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. - 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. +=item * gsl_poly_complex_solve_cubic - gsl_poly_complex_workspace_free($w) - This function frees all the memory associated with the workspace w. +=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. - gsl_poly_complex_solve +=item * gsl_poly_complex_workspace_free($w) - This function frees all the memory associated with the workspace w. + +=item * gsl_poly_complex_solve + +=back For more informations on the functions, we refer you to the GSL offcial documentation: L -- 2.11.4.GIT