Mercurial > octave
diff etc/NEWS.9.md @ 33323:0d2a6a831574 stable
doc: note fminX parameter passing removal, document alternatives (bug #55742)
* NEWS.9.md: Add note describing plan for Octave 10 removal of
undocumented fminsearch behavior allowing parameter passing through to fcn.
Note anonymous function parameter handling example has been added to
Minimizers manual section. Note that application notes were added to
fminbnd, fminsearch, and fminunch docstrings.
* fminsearch.m: Add application note describing discouraged use and pending
removal of directly passing parameted through undocumented fminsearch
feature, and preference to use anonymous functions for that purpose.
* fminbnd.m, fminunc.m: Add application note describing parameter
passing through the use of anonymous functions.
* nonlin.txi: Add to Minimizers section an example of using
an anonymous function for parameter handling with minimizaion functions.
| author | Nicholas R. Jankowski <jankowski.nicholas@gmail.com> |
|---|---|
| date | Thu, 04 Apr 2024 15:13:32 -0400 |
| parents | 308060bc6b27 |
| children | 263ddd6b96f7 cc632fa52f9d |
line wrap: on
line diff
--- a/etc/NEWS.9.md Wed Apr 03 20:07:44 2024 +0200 +++ b/etc/NEWS.9.md Thu Apr 04 15:13:32 2024 -0400 @@ -29,8 +29,27 @@ - Describe shape of outputs for `hist` (bug #65471). - Simplify programming notes for `patch` objects (bug #65421). - `vecnorm.m`: Add missing parenthesis to equation in docstring. +- Add example to Minimizers section on using anonymous functions to pass + examples to functions called by minimizer functions (`fminsearch`, + `fminbnd`, `fminunc`). +- Add application notes in `fminsearch`, `fminbnd`, `fminunc` indicated the + preferred way to pass parameters is through anonymous functions. - Update remaining copyright statements to 2024. +### Deprecated functions, properties, and operators + +- `fminsearch` parameter passing: A legacy, undocumented, and only partially + supported syntax for passing parameters to the minimized function `fcn` + called by `fminsearch` by appending them to the input argument list has + functioned intermittently since Octave 4.4.0. Due to conflicts with other + compatibility-required input methods the documentation of this syntax was + removed in Octave 5.1.0, and the remaining functionality will be completely + removed in Octave 10. The preferred, cross-platform compatible method of + passing parameters to any of the minimization functions (including + `fminsearch`, `fminbnd`, and `fminunc`) is through the use of Anonymous + Functions. Specific examples of this can be found in the @ref{Minimizers} + section of the GNU Octave manual. + Summary of important user-visible changes for version 9 (2024-03-12): ---------------------------------------------------------------------