[Scipy-svn] r2409 - trunk/Lib/integrate

[scipy-svn at scipy.org]

Author: oliphant
Date: 2006-12-13 16:04:51 -0600 (Wed, 13 Dec 2006)
New Revision: 2409

Modified:
   trunk/Lib/integrate/quadrature.py
Log:
Update docstring for romb

Modified: trunk/Lib/integrate/quadrature.py
===================================================================
--- trunk/Lib/integrate/quadrature.py	2006-12-13 21:18:18 UTC (rev 2408)
+++ trunk/Lib/integrate/quadrature.py	2006-12-13 22:04:51 UTC (rev 2409)
@@ -268,10 +268,21 @@
     return result
 
 def romb(y, dx=1.0, axis=-1, show=False):
-    """Uses Romberg integration to integrate y(x) using N samples
-    along the given axis which are assumed equally spaced with distance dx.
-    The number of samples must be 1 + a non-negative power of two: N=2**k + 1
+    """Romberg integration using samples of a function
 
+    Inputs:
+
+       y    -  a vector of 2**k + 1 equally-spaced samples of a fucntion
+       dx   -  the sample spacing.
+       axis -  the axis along which to integrate
+       show -  When y is a single 1-d array, then if this argument is True
+               print the table showing Richardson extrapolation from the
+               samples.
+
+    Output: ret
+
+       ret  - The integrated result for each axis. 
+
     See also:
 
       quad - adaptive quadrature using QUADPACK