changeset 8617:4b26e9fbbb37

fix lookup's docstring
author Jaroslav Hajek <highegg@gmail.com>
date Wed, 28 Jan 2009 13:53:49 +0100
parents 3d75d717cbe0
children f8b3ece45bda
files src/ChangeLog src/DLD-FUNCTIONS/lookup.cc
diffstat 2 files changed, 11 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Wed Jan 28 13:01:57 2009 +0100
+++ b/src/ChangeLog	Wed Jan 28 13:53:49 2009 +0100
@@ -1,3 +1,7 @@
+2009-01-28  Jaroslav Hajek  <highegg@gmail.com>
+
+	* DLD-FUNCTIONS/lookup.cc (Flookup): Fix doc string.
+
 2009-01-27  John W. Eaton  <jwe@octave.org>
 
 	* load-path.cc (Fcommand_line_path): Rename from Fcommandlinepath.
--- a/src/DLD-FUNCTIONS/lookup.cc	Wed Jan 28 13:01:57 2009 +0100
+++ b/src/DLD-FUNCTIONS/lookup.cc	Wed Jan 28 13:53:49 2009 +0100
@@ -102,20 +102,24 @@
 
 DEFUN_DLD (lookup, args, ,
   "-*- texinfo -*-\n\
-@deftypefn {Function File} {@var{idx} =} lookup (@var{table}, @var{y}, @var{opt})\n\
+@deftypefn {Loadable Function} {@var{idx} =} lookup (@var{table}, @var{y}, @var{opt})\n\
 Lookup values in a sorted table.  Usually used as a prelude to\n\
 interpolation.\n\
 \n\
 If table is strictly increasing and @code{idx = lookup (table, y)}, then\n\
 @code{table(idx(i)) <= y(i) < table(idx(i+1))} for all @code{y(i)}\n\
-within the table.  If @code{y(i)} is before the table, then\n\
-@code{idx(i)} is 0. If @code{y(i)} is after the table then\n\
+within the table.  If @code{y(i) < table (1)} then\n\
+@code{idx(i)} is 0. If @code{y(i) >= table(end)} then\n\
 @code{idx(i)} is @code{table(n)}.\n\
 \n\
 If the table is strictly decreasing, then the tests are reversed.\n\
 There are no guarantees for tables which are non-monotonic or are not\n\
 strictly monotonic.\n\
 \n\
+The algorithm used by lookup is standard binary search, with optimizations\n\
+to speed up the case of partially ordered arrays (dense downsampling).\n\
+In particular, looking up a single entry is of binary complexity.\n\
+\n\
 @var{table} and @var{y} can also be a cell array of strings\n\
 (or @var{y} can be a single string). In this case, string lookup\n\
 is performed using lexicographical comparison.\n\