bugGNU Octave - Bugs: bug #55094, "unimplemented function"...

 
 

bug #55094: "unimplemented function" helper omits functions moved to statistics package

Submitter:  Rafael Laboissière <rlaboiss>
Submitted:  Sun 25 Nov 2018 04:05:56 PM UTC
   
 
Category:  Documentation Severity:  4 - Important
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Open/Closed:  * Closed
Release:  * 4.4.1 Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Fri 21 Dec 2018 10:35:13 PM UTC, comment #5: 

Thanks for commenting. I've updated the list of functions, this is on the stable branch and will be part of the Octave 5 release:

https://hg.savannah.gnu.org/hgweb/octave/rev/d41d137af059

This change should apply cleanly to Octave 4.4.1 as well, for anyone that wants to backport it to the current stable release (e.g. for fixing that Debian bug in case Octave 5 doesn't get in before the upcoming release freeze ;)

Mike Miller <mtmiller>
Group Member
Wed 19 Dec 2018 11:58:27 PM UTC, comment #4: 

@Mike: I agree to your conclusion of comment #3 to advertise any feature or function Octave can provide.  That is to give the user a hint how to make use of all 114 functions by installing the statistics package in this case.

If we don't document it there, I guess we'll have to answer many questions on the mailing list.

Kai Torben Ohlhus <siko1056>
Group Member
Tue 18 Dec 2018 08:44:25 PM UTC, comment #3: 

Can another maintainer help me decide the following: should the '__unimplemented__.m' function file contain functions in a package that are well-known documented Matlab toolbox functions only? Should it also contain functions that used to be in Octave but are not Matlab compatible functions? Should it also contain all functions in a package, whether or not they are Matlab compatible or used to be in Octave?

There are 114 functions that were removed from Octave 4.4 and are now provided by the statistics package. Of those 114, 67 of them are well-known names corresponding to documented Matlab functions. The remaining 47 functions are Octave specific, or possibly functions that have been removed from Matlab or have a different naming convention.

I think we should definitely document the 67 functions, so when a user enters "help normcdf" for example, they will be directed to the statistics package.

Do we also want to cover the additional 47 non-Matlab-compatible functions that we know are now in the statistics package? For example, should "help cauchy_cdf" also direct the user to the statistics package? I lean towards yes for these also, because a previous version of Octave used to provide them.

Mike Miller <mtmiller>
Group Member
Tue 18 Dec 2018 07:50:50 PM UTC, comment #2: 

The Debian bug assumes that the directory structure has something to do with whether functions are tracked in the missing function hook, but this isn't really the case. The bug is simply that when the statistics functions were moved from Octave to the Forge statistics package, they were not added to the missing function hook, that should be done now. This should be a simple rote task of getting the list of functions moved from the NEWS file and merging them into the '__unimplemented__.m' function file.

I'm updating the summary to the specific and clear case of the statistics package functions that were removed from Octave 4.4. I think this should be fixed for the Octave 5 release.

The Debian bug report also points to the 'bsltl', 'geometry', and 'ltfat' packages, which are currently not handled at all by the '__unimplemented__.m' function file, but I think those should be looked at on a case by case basis.

Mike Miller <mtmiller>
Group Member
Sun 25 Nov 2018 08:08:29 PM UTC, comment #1: 

Referring to the downstream bug report, a "diagonal" look through __uniplemented__.m indicates that the list of functions for the OF statistics package, and probably other packages as well, is simply incomplete; supposedly all function entries have been added manually.

Fixing this looks to be an easy yet quite involved job.

That said, the list of unimplemented matlab fnctions is a moving target anyway.

Philip Nienhuis <philipnienhuis>
Group Member
Sun 25 Nov 2018 04:05:56 PM UTC, original submission:  

I am forwarding here a bug report filled against the Debian packages octave:
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=914391

Essentially, the bug reporter complains that the _unimplemented_ function is not considering functions installed in subdirectories of the packages' directories.

Rafael Laboissière <rlaboiss>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by siko1056 (Posted a comment)
  • -email is unavailable- added by rlaboiss (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 8 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-12-21 mtmiller StatusConfirmed Fixed
        Open/ClosedOpen Closed
    2018-12-18 mtmiller CategoryNone Documentation
        Severity3 - Normal 4 - Important
        Item GroupIncorrect Result Documentation
        Summary&quot;unimplemented function&quot; helper overlooks functions in package subdirectories "unimplemented function" helper omits functions moved to statistics package
    2018-11-25 philipnienhuis Item GroupNone Incorrect Result
        StatusNone Confirmed

    Back to the top

    Powered by Savane 3.13-d3ae.
    Corresponding source code