[Changeset] Re: documentation of lsode, dasrt, daspk, and dassl incompletely reflects wrapper change

[Thomas Treichl]

John W. Eaton schrieb:
> On 10-Feb-2009, Olaf Till wrote:
> 
> | --- In the lsode doc, the two sentences:
> | 
> | 
> |      The first argument, FCN, is a string, or cell array of strings,
> |      inline or function handles, that names the function to call to
> |      compute the vector of right hand sides for the set of equations.
> | 
> | and
> | 
> |      If FCN is a two-element string array, the first element names the
> |      function f described above, and the second element names a function
> |      to compute the Jacobian of f.
> | 
> | 
> | are a bit inconsistent and should be replaced by something like:
> | 
> | 
> |      The first argument, FCN, is a string, inline, or function handle
> |      that names the function f to call to compute the vector of right
> |      hand sides for the set of equations.
> | 
> | and
> | 
> |      If FCN is a two-element string array or a two-element cell array
> |      of strings, inlines, or function handles, the first element names
> |      the function f described above, and the second element names a
> |      function to compute the Jacobian of f.
> | 
> | 
> | The equivalent applies to the following functions (but I have not
> | looked into their sources and only assume that their wrappers had been
> | reworked equivalently to lsode):
> | 
> | 
> | --- daspk:
> | 
> | change
> | 
> |      The first argument, FCN, is a string or a two element cell array
> |      of strings, inline or function handle, that names the function, to
> |      call to compute the vector of residuals for the set of equations.
> | 
> | and
> | 
> |      If FCN is a two-element string array, the first element names the
> |      function f described above, and the second element names a
> |      function to compute the modified Jacobian
> | 
> | 
> | to
> | 
> | 
> |      The first argument, FCN, is a string, inline, or function handle
> |      that names the function f to call to compute the vector of
> |      residuals for the set of equations.
> | 
> | and
> | 
> |      If FCN is a two-element string array or a two-element cell array
> |      of strings, inlines, or function handles, the first element names
> |      the function f described above, and the second element names a
> |      function to compute the modified Jacobian
> | 
> | 
> | --- dassl:
> | 
> |      The first argument, FCN, is a string or a two element cell array
> |      of strings, inline or function handle, that names the function, to
> |      call to compute the vector of residuals for the set of equations.
> | 
> | and
> | 
> |      If FCN is a two-element string array, the first element names the
> |      function f described above, and the second element names a
> |      function to compute the modified Jacobian
> | 
> | (change to the same as in daspk)
> | 
> | 
> | --- dasrt (better here, but could be changed to be consistent with the
> | above changes):
> | 
> |      The first argument, FCN, is a string, or cell array of strings or
> |      inline or function handles, that names the function to call to
> |      compute the vector of residuals for the set of equations.
> | 
> | and
> | 
> |      If FCN is a two-element string array, or two element cell array,
> |      the first element names the function f described above, and the
> |      second element names a function to compute the modified Jacobian
> | 
> | (change to the same as in daspk)
> | 
> | 
> | 
> | (Documentation of fsolve seems to be already ok after the wrapper
> | change.)
> 
> Would someone like to verify this is correct for all these functions
> and create a changeset?

Changeset attached and attributed to Olaf.

Best regards,

   Thomas
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: solver.changeset
Url: https://www-old.cae.wisc.edu/pipermail/bug-octave/attachments/20090217/01506dfe/attachment.ksh