[Scipy-svn] r2465 - trunk/Lib/linsolve

[scipy-svn at scipy.org]

Author: jarrod.millman
Date: 2006-12-23 09:09:27 -0600 (Sat, 23 Dec 2006)
New Revision: 2465

Modified:
   trunk/Lib/linsolve/linsolve.py
Log:
added a docstring for linsolve.splu (see ticket #312)


Modified: trunk/Lib/linsolve/linsolve.py
===================================================================
--- trunk/Lib/linsolve/linsolve.py	2006-12-23 00:00:43 UTC (rev 2464)
+++ trunk/Lib/linsolve/linsolve.py	2006-12-23 15:09:27 UTC (rev 2465)
@@ -86,6 +86,10 @@
 
 def splu(A, permc_spec=2, diag_pivot_thresh=1.0,
          drop_tol=0.0, relax=1, panel_size=10):
+    """
+    A linear solver, for a square matrix A, using LU decomposition where
+    L is a lower triangular matrix and U is an upper triagular matrix.
+    """
     M, N = A.shape
     if (M != N):
         raise ValueError, "can only factor square matrices"