bugGNU Octave - Bugs: bug #51965, ode functions decic, ode15i, and...


bug #51965: ode functions decic, ode15i, and ode15s are not mentioned in NEWS or manual

Submitted by:  Mike Miller <mtmiller>
Submitted on:  Fri 08 Sep 2017 07:16:00 PM UTC  
Category:  Documentation Severity:  4 - Important
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Open/Closed:  Closed
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)

Tue 27 Mar 2018 11:29:36 PM UTC, comment #11: 

Heroic!  I'm happy its improved for the release.

IMHO, in these cases, your extra work should be a separate commit on top of mine, instead of re-writing the commit.  Of course for minor edits, a rewrite is fine.  But this gives me additional attribution---I did not proofread all the m-files (as you clearly did).  As an example, "hg blame" might be less useful in the future.

Of course, no need to change anything just my $0.02.

Colin Macdonald <cbm>
Tue 27 Mar 2018 09:53:03 PM UTC, comment #10: 

This has been a monster pain in the ass.  The example in the documentation was "Robetson's" instead of "Robertson's" and the function was declared as "robertsidae" which I renamed to "robertson_dae".  Anyways, this should be good enough for the release (http://hg.savannah.gnu.org/hgweb/octave/rev/f886561f9696).

Rik <rik5>
Project Administrator
Tue 27 Mar 2018 09:14:59 PM UTC, comment #9: 

Bah, english ;-)

((high-order accurate), (variable-step)) method

How about just:

> using the high-order @nospell{Dormand--Prince} method.  It
> requires six function evaluations per integration step but may

(the variable step bit is probably implied by the ode23 text before.)

Colin Macdonald <cbm>
Tue 27 Mar 2018 08:57:25 PM UTC, comment #8: 

@Colin: Should this phrase

high-order accurate variable-step ... method


high-order, accurate, variable-step ... method


high-order-accurate variable-step ... method

I can't figure out if high-order is modifying "accurate" or "method".

Rik <rik5>
Project Administrator
Tue 27 Mar 2018 07:48:18 PM UTC, comment #7: 

@Rik, sure thanks.

I should've said that I don't mind either way.  The important change was something like "high--order" which is certainly is incorrect.

Colin Macdonald <cbm>
Tue 27 Mar 2018 07:45:01 PM UTC, comment #6: 

Okay, also quoting from the Wikipedia entry:

The preference for an en dash instead of a hyphen in these coordinate/relationship/connection types of terms is a matter of style preference, not inherent orthographic "correctness"; both are equally "correct", and each is the preferred style in some style guides. For example, the American Heritage Dictionary of the English Language, the AMA Manual of Style, and Dorland's medical reference works use hyphens, not en dashes, in coordinate terms (such as blood–brain barrier), in eponyms (such as Cheyne–Stokes respiration, Kaplan–Meier method), and so on.

This comes down to which style guide you want to follow.  I generally don't want to pay for the yearly updates to something like the Chicago Manual of Style so I use the style manual of the U.S. Government Printing Office (https://www.gpo.gov/fdsys/search/pagedetails.action?granuleId=&packageId=GPO-STYLEMANUAL-2008).  This is good and I already paid for it with my tax dollars.  According to the GPO:

An en dash is used--
8.72.         In a combination of (1) figures, (2) capital letters, or (3)
        figures and capital letters. An en dash, not a hyphen, is used,
        even when such terms are adjectival modifiers.

            5-20 (bonds)
            85-1-85-20 (Public laws. Note em dash between two elements
              with en dashes)
            1-703-765-6593 (telephone number)
            230-20-8030 (Social Security number)
            $15-$25 (range)
        capital letters:
            WTOP-AM-FM-TV (radio and television stations)
            AFL-CIO (union merger)
            C-SPAN (satellite television)
        figures and capitals:
            6-A (exhibit identification)
            DC-14 (airplane)
            I-95 (interstate roadway)
            4-H (Club)
            LK-66-A(2)-74 (serial number)
       but  Rule 13e-4
            section 12(a)-(b) (en dash used for the word ``to'')
            ACF-Brill Motors Co. (hyphen with capital letters and a
            loran-C (hyphen with lowercase word and capital letter)
            MiG-25 (hyphen with mixed letters with figure)
            ALL-AMERICAN ESSAY CONTEST (hyphen in capitalized heading)
            Four Corners Monument, AZ-NM-UT-CO (hyphen with two-letter
              state abbreviations)

If I follow their guidelines, I do not use an en-dash between two names because the names do not consist of figure, capital letters, or a mix of figures and capitals.

This is probably good enough for now and I'll check in your patch with the change of en-dash to hyphen.

Rik <rik5>
Project Administrator
Tue 27 Mar 2018 06:59:31 PM UTC, comment #5: 

1.  Runge&ndash;Kutta is common usage in numerical analysis.  I looked for a reference: the [wikipedia page](https://en.wikipedia.org/wiki/Dash#En_dash) talks about "Bose&ndeshEinstein"

> ...while others consider an en dash appropriate in instances
> such as this[18][19][20] to represent the parallel
> relationship, as in the McCain–Feingold bill or
> Bose–Einstein statistics.

I also searched "endash names in mathematics" but haven't really found an authoritative source yet...

2.  y' = 0 = f(t,y,y') is wrong.  The previous docs were wrong.  The fully-implicit case is 0 = f(t,y,y'), that is where y' is described implicitly by f = 0.  This is contrast with the usual y' = f(t, y)

Colin Macdonald <cbm>
Tue 27 Mar 2018 05:44:34 PM UTC, comment #4: 

@Colin: I had a question about the change to dashes.  Using '--' in TeXinfo produces an en-dash.  Usually compound adjectives just need a hyphen.  Is there some special reason to want an en-dash in an expression like "Dormand--Prince method" where the two names form a compound adjective?

Occasionally one uses an en-dash to show connection, as in the "Washington--Baltimore train line".  And even more infrequently, one uses the en-dash to show connection with each side having equal weight as in "The Mason--Dixon Line".

I think I would just use regular hyphens here to form a compound adjective "Dormand-Prince" modifying "method".

Second question was this change

-## name of the function that defines the ODE: @code{y' = f(t,y,yp)}.  The
+## name of the function that defines the ODE: @code{0 = f(t,y,yp)}.  The

Would it be clearer to write

+## name of the function that defines the ODE: @code{y' = 0 = f(t,y,yp)}.  The

It seems that it is still useful to document that the function f calculates the first derivative of y.

Rik <rik5>
Project Administrator
Tue 27 Mar 2018 07:58:44 AM UTC, comment #3: 

I tried here https://savannah.gnu.org/patch/?9609

I just noticed I missed NEWS; I can redo if you want?  Or if you do it, I guess it should say something like "added stiff differential equation solvers `ode15s` and `ode15i`".

Colin Macdonald <cbm>
Tue 27 Mar 2018 02:30:49 AM UTC, comment #2: 

I know this stuff; I will try to do it this week.  But I certainly don't mind if others beat me to it!

Colin Macdonald <cbm>
Mon 26 Mar 2018 11:06:45 PM UTC, comment #1: 

Cc Rik, since you just mentioned this on the mailing list. I noticed this a while ago, looks like no one got around to it yet.

Mike Miller <mtmiller>
Project Administrator
Fri 08 Sep 2017 07:16:00 PM UTC, original submission:  

The ode functions decic, ode15i, and ode15s are not listed in the NEWS file and are not referenced in the user manual (doc/interpreter/diffeq.txi). It's trivial to add to NEWS and add the DOCSTRING entries, but it looks like someone familiar with these functions should write a short description in diffeq.txi also.

Mike Miller <mtmiller>
Project Administrator


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

Attach Files:

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 rik5 (Posted a comment)
  • -email is unavailable- added by cbm (Posted a comment)
  • -email is unavailable- added by mtmiller
  • -email is unavailable- added by mtmiller (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 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-03-27 rik5 StatusIn Progress => Fixed
        Open/ClosedOpen => Closed
    2018-03-27 rik5 StatusNone => In Progress
    2018-03-26 mtmiller Severity3 - Normal => 4 - Important
        Carbon-Copy- => Added rik5

    Back to the top

    Powered by Savane 3.7