bugGNU Octave - Bugs: bug #49360, odeset lacks documentation for...

 
 

bug #49360: odeset lacks documentation for solver options

Submitted by:  Rik <rik5>
Submitted on:  Sun 16 Oct 2016 05:01:53 PM UTC  
 
Category:  Documentation Severity:  2 - Minor
Priority:  5 - Normal Item Group:  Documentation
Status:  Postponed Assigned to:  None
Originator Name:  Open/Closed:  Open
Release:  dev Operating System:  Any

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

( Jump to the original submission)

Fri 28 Sep 2018 08:14:48 AM UTC, comment #8:

Rik, I think your point of comment #5 was that there is lots of documentation in the odepkg for "odeset" with examples [1] (line 1011 to 1821), that can really be used in the Octave manual [2] as well.

By the change of comment #6 I wished the users to at least know what is allowed for the individual parameters. The other transformation requires some review time, but might be as easy as a copy & paste when looking at them.

So maybe leave it open for another two years as project for the development branch ;-)

[1] https://bitbucket.org/odepkg/odepkg/src/5eba1b653be54c0bb383cf06f73f31e671a72816/doc/odepkg.texi?at=default&fileviewer=file-view-default#odepkg.texi-1011

[2] https://octave.org/doc/interpreter/Matlab_002dcompatible-solvers.html

Kai Torben Ohlhus <siko1056>
Project Member
Thu 27 Sep 2018 03:30:31 PM UTC, comment #7:

Is this bug now complete or is there more to do?

Rik <rik5>
Project Administrator
Wed 26 Sep 2018 02:49:58 PM UTC, comment #6:

Some update on the options documentation:

https://hg.savannah.gnu.org/hgweb/octave/rev/22f6cb277893

Kai Torben Ohlhus <siko1056>
Project Member
Mon 24 Oct 2016 06:48:30 PM UTC, comment #5:

The remaining issue before closing this report is to transfer more of the texi documentation from odepkg in to either the individual m-files or to diffeq.txi.

Rik <rik5>
Project Administrator
Mon 17 Oct 2016 04:13:37 PM UTC, comment #4:

Nir's patch applied here:

http://hg.savannah.gnu.org/hgweb/octave/rev/aace27d19162

c.

Carlo de Falco <cdf>
Project Member
Mon 17 Oct 2016 04:08:31 PM UTC, comment #3:

Jacopo proposed adding documentation from odepkg to diffeq.txi.

Rik <rik5>
Project Administrator
Mon 17 Oct 2016 04:06:28 PM UTC, comment #2:

Nir proposed some fix-ups. See attached odeset.diff.

(file #38744)

Rik <rik5>
Project Administrator
Mon 17 Oct 2016 10:06:09 AM UTC, comment #1:

An initial documentation of odeset otpions was pushed here:

http://hg.savannah.gnu.org/hgweb/octave/file/abfb538acc59/scripts/ode/odeset.m

More extensive documentation is available in the odepkg manual
and should probably be moved in the Octave interpreter manual.

Carlo de Falco <cdf>
Project Member
Sun 16 Oct 2016 05:01:53 PM UTC, original submission:

One of the goals of Octave is to be a viable replacement for Matlab. However, odeset has 23 tunable parameters, but no explanation for any of them. Octave is not a good replacement if we require the use of Matlab documentation in order to understand how to code for Octave.

Rik <rik5>
Project Administrator

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #38744:  odeset.diff added by rik5 (4KiB - text/x-diff)

 

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 rik5
  • -email is unavailable- added by cdf (Posted a comment)
  • -email is unavailable- added by rik5 (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

     

     

    Follow 9 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-09-28 siko1056 StatusIn Progress => Postponed
        Release4.4.1 => dev
    2018-09-26 mtmiller Carbon-CopyRemoved 80942 => -
    2018-09-26 siko1056 Release4.2.0 => 4.4.1
    2016-11-17 mtmiller Severity3 - Normal => 2 - Minor
        Release4.2.0-rc2 => 4.2.0
    2016-10-17 rik5 StatusConfirmed => In Progress
    2016-10-17 rik5 Attached File- => Added odeset.diff, #38744
        Carbon-Copy- => Added nir_krakauer

    Back to the top


    Powered by Savane 3.3