Changeset 35 for trunk

Show
Ignore:
Timestamp:
03/13/08 21:27:13 (8 months ago)
Author:
lhealy
Message:

More complete documentation for elliptic integrals.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/special-functions/elliptic-integrals.lisp

    r26 r35  
    11;; Elliptic integrals 
    22;; Liam Healy, Mon Mar 20 2006 - 21:50 
    3 ;; Time-stamp: <2008-02-16 20:47:06EST elliptic-integrals.lisp> 
     3;; Time-stamp: <2008-03-13 17:27:04EDT elliptic-integrals.lisp> 
    44;; $Id$ 
    55 
    … …  
    1313  "gsl_sf_ellint_Kcomp_e" ((k :double) :mode (ret sf-result)) 
    1414  :documentation                        ; FDL 
    15   "The complete elliptic integral K(k).") 
     15  "The complete elliptic integral of the first kind, K(k).  Note that 
     16  Abramowitz & Stegun define this function in terms of the parameter m 
     17  = k^2.") 
    1618 
    1719(defmfun elliptic-integral-E-complete (k) 
    1820  "gsl_sf_ellint_Ecomp_e" ((k :double) :mode (ret sf-result)) 
    1921  :documentation                        ; FDL 
    20   "The complete elliptic integral E(k).") 
     22  "The complete elliptic integral of the second kind, E(k). 
     23   Note that Abramowitz & Stegun define this function in terms of the 
     24   parameter m = k^2.") 
    2125 
    2226;;;;**************************************************************************** 
    … …  
    2731  "gsl_sf_ellint_F_e" ((phi :double) (k :double) :mode (ret sf-result)) 
    2832  :documentation                        ; FDL 
    29   "The incomplete elliptic integral F(\phi,k).") 
     33  "The incomplete elliptic integral of the first kind, F(phi,k).  Note 
     34  that Abramowitz & Stegun define this function in terms of the 
     35  parameter m = k^2.") 
    3036 
    3137(defmfun elliptic-integral-E (phi k) 
    3238  "gsl_sf_ellint_E_e" ((phi :double) (k :double) :mode (ret sf-result)) 
    3339  :documentation                        ; FDL 
    34   "The incomplete elliptic integral E(\phi,k).") 
     40  "The incomplete elliptic integral of the second kind, E(phi,k).  Note 
     41  that Abramowitz & Stegun define this function in terms of the 
     42  parameter m = k^2.") 
    3543 
    3644(defmfun elliptic-integral-P (phi k n) 
    … …  
    3846  ((phi :double) (k :double) (n :double) :mode (ret sf-result)) 
    3947  :documentation                        ; FDL 
    40   "The incomplete elliptic integral P(\phi,k,n).") 
     48  "The incomplete elliptic integral of the third kind, P(phi,k,n). 
     49  Note that Abramowitz & Stegun define this function in terms of the 
     50  parameters m = k^2 and sin^2(alpha) = k^2, with the change of sign 
     51  n to -n.") 
    4152 
    4253(defmfun elliptic-integral-D (phi k n)