[SciPy-Dev] Doc error in scipy.optimize.fmin and missing info in ref guide
Mon Mar 15 18:41:10 CDT 2010
I'll look into both problems.
On Mon, Mar 15, 2010 at 4:13 PM, <firstname.lastname@example.org> wrote:
> On Mon, Mar 15, 2010 at 7:05 PM, Rob Clewley <email@example.com>
> > Hi,
> > In both my old version and the one in the svn trunk there is an
> > inconsistency in the docstring of scipy.optimize.fmin.
> > Other Parameters
> > ----------------
> > xtol : float
> > Relative error in xopt acceptable for convergence.
> > ftol : number
> > Relative error in func(xopt) acceptable for convergence.
> > As you see from the following code snippet from the body of the
> > function, the convergence test is in terms of absolute error for both
> > x and f, as the sim array contains x values and fsim the function
> > values.
> > if (max(numpy.ravel(abs(sim[1:]-sim))) <= xtol \
> > and max(abs(fsim-fsim[1:])) <= ftol):
> > break
> > Also, optional parameters for any optimize functions are not described
> > in the draft of the Scipy reference manual I came across while
> > googling this issue. For instance, at
> > fmin does not have the optional arguments detailed. If this is
> > automatically generated is there a reason why the optional parameters
> > aren't being shown in this document? I think they should be, IMO.
> just a guess:
> shows that Other Parameters is in the wrong order. It could be that
> the section is ignored for rendering the html for this reason
> > -Rob
> > _______________________________________________
> > SciPy-Dev mailing list
> > SciPy-Dev@scipy.org
> > http://mail.scipy.org/mailman/listinfo/scipy-dev
> SciPy-Dev mailing list
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the SciPy-Dev