[Octave-bug-tracker] [bug #46265] Docs of lookup insufficient

[Francesco Potortì]

URL:
  <http://savannah.gnu.org/bugs/?46265>

                 Summary: Docs of lookup insufficient
                 Project: GNU Octave
            Submitted by: pot
            Submitted on: Wed 21 Oct 2015 01:43:25 PM CEST
                Category: Documentation
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Feature Request
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: 4.0.0
        Operating System: GNU/Linux

    _______________________________________________________

Details:

The docs start by saying «This function is usually used as a prelude to
interpolation.»  This is largely insufficient, because it does not say that
TABLE should be sorted and because it does not say first things first.

The above text should be substituted by:

«Look in TABLE for each element of Y and return an index into TABLE.  TABLE
is a sorted numeric array or a sorted cell array of strings.  Correspondingly,
Y is a number or a string.  Y can also be a numeric array or a cell array of
strings: in this case lookup returns an array of indexes into TABLE. This
function is usually used as a prelude to interpolation.»

Consequently, the next paragraph should end with the additional text
«Lexicographical comparison is used in the case of strings.»

Last, the paragraph «TABLE and Y can also be cell arrays of strings (or Y can
be a single string).  In this case, string lookup is performed using
lexicographical comparison.» should be removed.




    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?46265>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/