bugGNU Octave - Bugs: bug #60817, log2 documentation incorporate...

 
 

bug #60817: log2 documentation incorporate X=F*2^E

Submitter:  None
Submitted:  Thu 24 Jun 2021 09:49:39 AM UTC
   
 
Category:  Octave Function Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  Originator Email:  -email is unavailable-
Open/Closed:  * Closed Release:  * 6.2.0
Operating System:  * Any Fixed Release:  None
Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Thu 24 Jun 2021 09:48:29 PM UTC, comment #1: 

I made a few more changes to the documentation besides the one you suggested and checked them in on the stable branch.  See this changeset: http://hg.savannah.gnu.org/hgweb/octave/rev/ba571657651a.

Marking as fixed and closing report.

Rik <rik5>
Group administrator
Thu 24 Jun 2021 09:49:39 AM UTC, original submission:  

The current text returned from help log2 is

'log2' is a built-in function from the file libinterp/corefcn/data.cc

 -- log2 (X)
 -- [F, E] = log2 (X)
     Compute the base-2 logarithm of each element of X.

     If called with two output arguments, split X into binary mantissa
     and exponent so that '1/2 <= abs(f) < 1' and E is an integer.  If
     'x = 0', 'f = e = 0'.

     See also: pow2, log, log10, exp.

Additional help for built-in functions and operators is
available in the online version of the manual.  Use the command
'doc <topic>' to search the manual index.

Help and information about Octave is also available on the WWW
at https://www.octave.org and via the help@octave.org
mailing list.

I suggest changing it to

'log2' is a built-in function from the file libinterp/corefcn/data.cc

 -- log2 (X)
 -- [F, E] = log2 (X)
     Compute the base-2 logarithm of each element of X.

     If called with two output arguments, split X into binary mantissa
     and exponent X=F*2^E so that '1/2 <= abs(F) < 1' and E is an integer.  If
     'X = 0', 'F = E = 0'.

     See also: pow2, log, log10, exp.

Additional help for built-in functions and operators is
available in the online version of the manual.  Use the command
'doc <topic>' to search the manual index.

Help and information about Octave is also available on the WWW
at https://www.octave.org and via the help@octave.org
mailing list.

The suggested change is the inclusion of

X=F*2^E

so the relationship between the variables is clear.

Anonymous

 

(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 rik5 (Posted a comment)
  •  

    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 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2021-06-24 rik5 StatusNone Fixed
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-d3ae.
    Corresponding source code