[Scipy-tickets] [SciPy] #423: Docstring for optimize.fmin_tnc is wrong

SciPy scipy-tickets@scipy....
Wed May 23 20:50:42 CDT 2007


#423: Docstring for optimize.fmin_tnc is wrong
----------------------------+-----------------------------------------------
 Reporter:  baxissimo       |       Owner:  somebody
     Type:  defect          |      Status:  new     
 Priority:  normal          |   Milestone:          
Component:  scipy.optimize  |     Version:  devel   
 Severity:  normal          |    Keywords:          
----------------------------+-----------------------------------------------
 The documentation for fmin_tnc states:
    Outputs:

         x         : the solution (a list of floats)
         nfeval    : the number of function evaluations
         rc        : return code (corresponding message in
 optimize.tnc.RCSTRINGS)

 The actual return value seems to be the reverse of that, i.e. the tuple:
         (rc,nfeval,x).

 Probably the code should be changed to reflect the docstring rather than
 the other way around, because all of the other fmin_* optimizers return
 'x' as the first value.

 Using Scipy '0.5.3.dev3030' from an Enthought egg, on Windows XP. with
 Python 2.4.

-- 
Ticket URL: <http://projects.scipy.org/scipy/scipy/ticket/423>
SciPy <http://www.scipy.org/>
SciPy is open-source software for mathematics, science, and engineering.


More information about the Scipy-tickets mailing list