[Scipy-svn] r4704 - trunk/scipy/special

[scipy-svn at scipy.org]

Author: ptvirtan
Date: 2008-09-08 13:57:39 -0500 (Mon, 08 Sep 2008)
New Revision: 4704

Modified:
   trunk/scipy/special/cephes_doc.h
   trunk/scipy/special/info.py
Log:
Fix Bessel K_nu function name in docstrings: 'modified Bessel function of the second kind' is the more common name, rather than the 'third kind'

Modified: trunk/scipy/special/cephes_doc.h
===================================================================
--- trunk/scipy/special/cephes_doc.h	2008-09-08 14:47:40 UTC (rev 4703)
+++ trunk/scipy/special/cephes_doc.h	2008-09-08 18:57:39 UTC (rev 4704)
@@ -80,20 +80,20 @@
 #define jn_doc "y=jn(n,x) returns the Bessel function of integer order n at  x."
 #define jv_doc "y=jv(v,z) returns the Bessel function of real order v at complex z."
 #define jve_doc "y=jve(v,z) returns the exponentially scaled Bessel function of real order\nv at complex z: jve(v,z) = jv(v,z) * exp(-abs(z.imag))"
-#define k0_doc "y=i0(x) returns the modified Bessel function of the third kind of\norder 0 at x."
-#define k0e_doc "y=k0e(x) returns the exponentially scaled modified Bessel function\nof the third kind of order 0 at x.  k0e(x) = exp(x) * k0(x)."
-#define k1_doc "y=i1(x) returns the modified Bessel function of the third kind of\norder 1 at x."
-#define k1e_doc "y=k1e(x) returns the exponentially scaled modified Bessel function\nof the third kind of order 1 at x.  k1e(x) = exp(x) * k1(x)"
+#define k0_doc "y=k0(x) returns the modified Bessel function of the second kind (sometimes called the third kind) of\norder 0 at x."
+#define k0e_doc "y=k0e(x) returns the exponentially scaled modified Bessel function\nof the second kind (sometimes called the third kind) of order 0 at x.  k0e(x) = exp(x) * k0(x)."
+#define k1_doc "y=i1(x) returns the modified Bessel function of the second kind (sometimes called the third kind) of\norder 1 at x."
+#define k1e_doc "y=k1e(x) returns the exponentially scaled modified Bessel function\nof the second kind (sometimes called the third kind) of order 1 at x.  k1e(x) = exp(x) * k1(x)"
 #define kei_doc "y=kei(x) returns the Kelvin function ker x"
 #define keip_doc "y=keip(x) returns the derivative of the Kelvin function kei x"
 #define kelvin_doc "(Be, Ke, Bep, Kep)=kelvin(x) returns the tuple (Be, Ke, Bep, Kep) which containes \ncomplex numbers representing the real and imaginary Kelvin functions \nand their derivatives evaluated at x.  For example, \nkelvin(x)[0].real = ber x and kelvin(x)[0].imag = bei x with similar \nrelationships for ker and kei."
 #define ker_doc "y=ker(x) returns the Kelvin function ker x"
 #define kerp_doc "y=kerp(x) returns the derivative of the Kelvin function ker x"
-#define kn_doc "y=kn(n,x) returns the modified Bessel function of the third kind for\ninteger order n at x."
+#define kn_doc "y=kn(n,x) returns the modified Bessel function of the second kind (sometimes called the third kind) for\ninteger order n at x."
 #define kolmogi_doc "y=kolmogi(p) returns y such that kolmogorov(y) = p"
 #define kolmogorov_doc "p=kolmogorov(y) returns the complementary cumulative distribution \nfunction of Kolmogorov's limiting distribution (Kn* for large n) \nof a two-sided test for equality between an empirical and a theoretical \ndistribution. It is equal to the (limit as n->infinity of the) probability \nthat sqrt(n) * max absolute deviation > y."
-#define kv_doc "y=kv(v,z) returns the modified Bessel function of the third kind for\nreal order v at complex z."
-#define kve_doc "y=kve(v,z) returns the exponentially scaled, modified Bessel function\nof the third kind for real order v at complex z: kve(v,z) = kv(v,z) * exp(z)"
+#define kv_doc "y=kv(v,z) returns the modified Bessel function of the second kind (sometimes called the third kind) for\nreal order v at complex z."
+#define kve_doc "y=kve(v,z) returns the exponentially scaled, modified Bessel function\nof the second kind (sometimes called the third kind) for real order v at complex z: kve(v,z) = kv(v,z) * exp(z)"
 #define log1p_doc "y=log1p(x) calculates log(1+x) for use when x is near zero."
 #define lpmv_doc "y=lpmv(m,v,x) returns the associated legendre function of integer order\nm and nonnegative degree v: |x|<=1."
 #define mathieu_a_doc "lmbda=mathieu_a(m,q) returns the characteristic value for the even solution, \nce_m(z,q), of Mathieu's equation"

Modified: trunk/scipy/special/info.py
===================================================================
--- trunk/scipy/special/info.py	2008-09-08 14:47:40 UTC (rev 4703)
+++ trunk/scipy/special/info.py	2008-09-08 18:57:39 UTC (rev 4704)
@@ -25,9 +25,9 @@
 *  yn       -- Bessel function of second kind (integer order).
 *  yv       -- Bessel function of the second kind (real-valued order).
 *  yve      -- Exponentially scaled Bessel function of the second kind.
-*  kn       -- Modified Bessel function of the third kind (integer order).
-*  kv       -- Modified Bessel function of the third kind (real order).
-*  kve      -- Exponentially scaled modified Bessel function of the third kind.
+*  kn       -- Modified Bessel function of the second kind (integer order).
+*  kv       -- Modified Bessel function of the second kind (real order).
+*  kve      -- Exponentially scaled modified Bessel function of the second kind.
 *  iv       -- Modified Bessel function.
 *  ive      -- Exponentially scaled modified Bessel function.
 *  hankel1  -- Hankel function of the first kind.
@@ -60,10 +60,10 @@
 *  i0e      -- Exponentially scaled modified Bessel function of order 0.
 *  i1       -- Modified Bessel function of order 1.
 *  i1e      -- Exponentially scaled modified Bessel function of order 1.
-*  k0       -- Modified Bessel function of the third kind of order 0.
-*  k0e      -- Exponentially scaled modified Bessel function of the third kind of order 0.
-*  k1       -- Modified Bessel function of the third kind of order 1.
-*  k1e      -- Exponentially scaled modified Bessel function of the third kind of order 1.
+*  k0       -- Modified Bessel function of the second kind of order 0.
+*  k0e      -- Exponentially scaled modified Bessel function of the second kind of order 0.
+*  k1       -- Modified Bessel function of the second kind of order 1.
+*  k1e      -- Exponentially scaled modified Bessel function of the second kind of order 1.
 
 Integrals of Bessel Functions
 .............................