changeset 12553:7c915d013b9c

quadcc: Add reference to original paper in docstring.
author Rik <octave@nomad.inbox5.com>
date Thu, 31 Mar 2011 07:13:33 -0700
parents 1cfa3d9adf0a
children 4040a95a586d
files src/ChangeLog src/DLD-FUNCTIONS/quadcc.cc
diffstat 2 files changed, 13 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Wed Mar 30 13:07:53 2011 -0600
+++ b/src/ChangeLog	Thu Mar 31 07:13:33 2011 -0700
@@ -1,3 +1,7 @@
+2011-03-31  Rik  <octave@nomad.inbox5.com>
+
+	* DLD-FUNCTIONS/quadcc.cc: Add reference to original paper in docstring.
+
 2011-03-30  Jordi GutiƩrrez Hermoso  <jordigh@gmail.com>
 
 	* file-io.cc: Document the "all" parameter to fclose.
--- a/src/DLD-FUNCTIONS/quadcc.cc	Wed Mar 30 13:07:53 2011 -0600
+++ b/src/DLD-FUNCTIONS/quadcc.cc	Thu Mar 31 07:13:33 2011 -0700
@@ -1481,14 +1481,13 @@
 "-*- texinfo -*-\n\
 @deftypefn  {Function File} {[@var{int}, @var{err}, @var{nr_points}] =} quadcc (@var{f}, @var{a}, @var{b}, @var{tol})\n\
 @deftypefnx {Function File} {[@var{int}, @var{err}, @var{nr_points}] =} quadcc (@var{f}, @var{a}, @var{b}, @var{tol}, @var{sing})\n\
-Numerically evaluates an integral using the doubly-adaptive\n\
-quadrature described by P. Gonnet in @cite{Increasing the\n\
-Reliability of Adaptive Quadrature Using Explicit Interpolants},\n\
-ACM Transactions on Mathematical Software, in Press, 2010.\n\
+Numerically evaluate an integral using the doubly-adaptive\n\
+Clenshaw-Curtis quadrature described by P. Gonnet in @cite{Increasing the\n\
+Reliability of Adaptive Quadrature Using Explicit Interpolants}.\n\
 The algorithm uses Clenshaw-Curtis quadrature rules of increasing\n\
 degree in each interval and bisects the interval if either the\n\
 function does not appear to be smooth or a rule of maximum\n\
-degree has been reached. The error estimate is computed from the\n\
+degree has been reached.  The error estimate is computed from the\n\
 L2-norm of the difference between two successive interpolations\n\
 of the integrand over the nodes of the respective quadrature rules.\n\
 \n\
@@ -1533,8 +1532,8 @@
 with @code{x=tan(pi/2*u)}.\n\
 \n\
 @code{quadcc} is capable of dealing with non-numeric\n\
-values of the integrand such as @code{NaN}, @code{Inf}\n\
-or @code{-Inf}, as in the above example at x=0.\n\
+values of the integrand such as @code{NaN} or @code{Inf}\n\
+, as in the above example at x=0.\n\
 If the integral diverges and @code{quadcc} detects this, \n\
 a warning is issued and @code{Inf} or @code{-Inf} is returned.\n\
 \n\
@@ -1543,6 +1542,9 @@
 well-behaved integrand than other methods such as\n\
 @code{quadgk} or @code{trapz}.\n\
 \n\
+Reference: P. Gonnet, @cite{Increasing the Reliability of Adaptive\n\
+Quadrature Using Explicit Interpolants}, ACM Transactions on\n\
+Mathematical Software, Vol. 37, Issue 3, Article No. 3, 2010.\n\
 @seealso{quad, quadv, quadl, quadgk, trapz, dblquad, triplequad}\n\
 @end deftypefn")
 {