[Scipy-svn] r3200 - trunk/Lib/linalg

[scipy-svn at scipy.org]

Author: cdavid
Date: 2007-07-26 22:34:16 -0500 (Thu, 26 Jul 2007)
New Revision: 3200

Modified:
   trunk/Lib/linalg/iterative.py
Log:
* For iterative solvers in linalg, fix docstrings to say that initial guess is
overwritten with final value.


Modified: trunk/Lib/linalg/iterative.py
===================================================================
--- trunk/Lib/linalg/iterative.py	2007-07-26 19:00:23 UTC (rev 3199)
+++ trunk/Lib/linalg/iterative.py	2007-07-27 03:34:16 UTC (rev 3200)
@@ -130,7 +130,7 @@
 
     Optional Inputs:
 
-    x0  -- (0) default starting guess
+    x0  -- (0) default starting guess (overwritten with final value)
     tol -- (1e-5) relative tolerance to achieve
     maxiter -- (10*n) maximum number of iterations
     xtype  --  The type of the result.  If None, then it will be
@@ -248,7 +248,7 @@
 
     Optional Inputs:
 
-    x0  -- (0) default starting guess
+    x0  -- (0) default starting guess (overwritten with final value)
     tol -- (1e-5) relative tolerance to achieve
     maxiter -- (10*n) maximum number of iterations
     xtype  --  The type of the result.  If None, then it will be
@@ -358,7 +358,7 @@
 
     Optional Inputs:
 
-    x0  -- (0) default starting guess
+    x0  -- (0) default starting guess (overwritten with final value)
     tol -- (1e-5) relative tolerance to achieve
     maxiter -- (10*n) maximum number of iterations
     xtype  --  The type of the result.  If None, then it will be
@@ -468,7 +468,7 @@
 
     Optional Inputs:
 
-    x0  -- (0) default starting guess
+    x0  -- (0) default starting guess (overwritten with final value)
     tol -- (1e-5) relative tolerance to achieve
     maxiter -- (10*n) maximum number of iterations
     xtype  --  The type of the result.  If None, then it will be
@@ -578,10 +578,10 @@
 
     Optional Inputs:
 
+    x0  -- (0) default starting guess (overwritten with final value)
+    tol -- (1e-5) relative tolerance to achieve
     restrt -- (n) When to restart (change this to get faster performance -- but
                    may not converge).
-    x0  -- (0) default starting guess
-    tol -- (1e-5) relative tolerance to achieve
     maxiter -- (10*n) maximum number of iterations
     xtype  --  The type of the result.  If None, then it will be
                determined from A.dtype.char and b.  If A does not have a
@@ -692,7 +692,7 @@
 
     Optional Inputs:
 
-    x0  -- (0) default starting guess
+    x0  -- (0) default starting guess (overwritten with final value)
     tol -- (1e-5) relative tolerance to achieve
     maxiter -- (10*n) maximum number of iterations
     xtype  --  The type of the result.  If None, then it will be