Author: bugman
Date: Sun Oct 1 07:54:42 2006
New Revision: 2597
URL: http://svn.gna.org/viewcvs/relax?rev=2597&view=rev
Log:
This change implements half of task #3630 (https://gna.org/task/?3630).
The docstring in the generic optimisation function has been modified to clear
up the ambiguity cased
by supplying the option 'None' together with Newton optimisation.
Modified:
1.2/minimise/generic.py
Modified: 1.2/minimise/generic.py
URL:
http://svn.gna.org/viewcvs/relax/1.2/minimise/generic.py?rev=2597&r1=2596&r2=2597&view=diff
==============================================================================
--- 1.2/minimise/generic.py (original)
+++ 1.2/minimise/generic.py Sun Oct 1 07:54:42 2006
@@ -270,6 +270,12 @@
|___________________________________|_____________________________________________________|
+ As both the line search algorithm and Hessian modification can be
specified for Newton
+ optimisation, supplying the option 'None' may appear to be ambiguous.
In fact, the Hessian
+ takes precedence over the line search. Hence supplying the option
'None' with the Newton
+ algorithm selects the unmodified Hessian. Supplying 'None' twice will
turn off the Hessian
+ modification and no step length selection (or line search) will be
performed.
+
Hessian type, these are used in a few of the trust region methods
including the Dogleg and Exact
trust region algorithms. In these cases, when the Hessian type is set
to Newton, a Hessian
r2597 - /1.2/minimise/generic.py