[Octave-bug-tracker] [bug #60817] log2 documentation incorporate X=F*2^E

[anonymous]

URL:
  <https://savannah.gnu.org/bugs/?60817>

                 Summary: log2 documentation incorporate X=F*2^E
                 Project: GNU Octave
            Submitted by: None
            Submitted on: Thu 24 Jun 2021 09:49:39 AM UTC
                Category: Octave Function
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
                 Release: 6.2.0
         Discussion Lock: Any
        Operating System: Any

    _______________________________________________________

Details:

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.




    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?60817>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/