[Scipy-svn] r6693 - trunk/scipy/optimize

[scipy-svn at scipy.org]

Author: ptvirtan
Date: 2010-09-07 16:53:55 -0500 (Tue, 07 Sep 2010)
New Revision: 6693

Modified:
   trunk/scipy/optimize/nonlin.py
Log:
DOC: optimize/nonlin: update KrylovJacobian documentation

Modified: trunk/scipy/optimize/nonlin.py
===================================================================
--- trunk/scipy/optimize/nonlin.py	2010-09-07 21:53:41 UTC (rev 6692)
+++ trunk/scipy/optimize/nonlin.py	2010-09-07 21:53:55 UTC (rev 6693)
@@ -1290,6 +1290,10 @@
 
         >>> jac = BroydenFirst()
         >>> kjac = KrylovJacobian(inner_M=jac.inverse).
+
+        If the preconditioner has a method named 'update', it will be called
+        as ``update(x, f)`` after each nonlinear step, with ``x`` giving
+        the current point, and ``f`` the current function value.
     inner_tol, inner_maxiter, ...
         Parameters to pass on to the \"inner\" Krylov solver.
         See `scipy.sparse.linalg.gmres` for details.