Mercurial > octave
diff libinterp/corefcn/lookup.cc @ 21966:112b20240c87
move docstrings in C++ files out of C strings and into comments
* __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc,
__ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc,
bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc,
dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc,
dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc,
fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc,
hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc,
pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc,
sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc,
utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc,
convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc,
ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc,
ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc,
ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc,
ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc,
pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy:
Docstrings are now comments instead of C strings.
* build-aux/mk-opts.pl: Emit docstrings as comments instead of C
strings.
* DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments.
* builtins.h: Include builtin-defun-decls.h unconditionally.
* defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration.
(DEFALIAS): Always expand to nothing.
* defun-dld.h: No special macro expansions for MAKE_BUILTINS.
(DEFUN_DLD): Use FORWARD_DECLARE_FUN.
(DEFUNX_DLD): Use FORWARD_DECLARE_FUNX.
* defun-int.h: No special macro expansions for MAKE_BUILTINS.
(FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros.
(DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass
"external-doc" to DEFINE_FUNX_INSTALLER_FUN.
(DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL,
DEFALIAS_INTERNAL): Delete.
* common.mk (move_if_change_rule): New macro.
(simple_move_if_change_rule): Define using move_if_change_rule.
* find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file
name extension to ".df".
* libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files.
* mkbuiltins: New argument, SRCDIR. Operate directly on source files.
* mkdefs: Delete.
* libinterp/module.mk (BUILT_SOURCES): Update list to contain only
files included in other source files.
(GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete.
(LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here.
(LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from
the list.
(libinterp_EXTRA_DIST): Remove mkdefs from the list.
(FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES.
(DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES.
(SRC_DEFUN_FILES): Rename from SRC_DEF_FILES.
(ALL_DEFUN_FILES): Rename from ALL_DEF_FILES.
(%.df: %.cc): Delete pattern rule.
(libinterp/build-env-features.cc, libinterp/builtins.cc,
libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change.
(libinterp/builtins.cc, libinterp/builtin-defun-decls.h):
Update mkbuiltins command.
($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command.
* liboctave/module.mk (BUILT_SOURCES): Don't include
liboctave-build-info.cc in the list.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 21 Jun 2016 16:07:51 -0400 |
parents | b571fc85953f |
children | e43d83253e28 |
line wrap: on
line diff
--- a/libinterp/corefcn/lookup.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/corefcn/lookup.cc Tue Jun 21 16:07:51 2016 -0400 @@ -188,55 +188,55 @@ } DEFUN (lookup, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {@var{idx} =} lookup (@var{table}, @var{y})\n\ -@deftypefnx {} {@var{idx} =} lookup (@var{table}, @var{y}, @var{opt})\n\ -Lookup values in a sorted table.\n\ -\n\ -This function is usually used as a prelude to interpolation.\n\ -\n\ -If table is increasing and @code{idx = lookup (table, y)}, then\n\ -@code{table(idx(i)) <= y(i) < table(idx(i+1))} for all @code{y(i)} within\n\ -the table. If @code{y(i) < table(1)} then @code{idx(i)} is 0. If\n\ -@code{y(i) >= table(end)} or @code{isnan (y(i))} then @code{idx(i)} is\n\ -@code{n}.\n\ -\n\ -If the table is decreasing, then the tests are reversed.\n\ -For non-strictly monotonic tables, empty intervals are always skipped.\n\ -The result is undefined if @var{table} is not monotonic, or if\n\ -@var{table} contains a NaN.\n\ -\n\ -The complexity of the lookup is O(M*log(N)) where N is the size of\n\ -@var{table} and M is the size of @var{y}. In the special case when @var{y}\n\ -is also sorted, the complexity is O(min(M*log(N),M+N)).\n\ -\n\ -@var{table} and @var{y} can also be cell arrays of strings\n\ -(or @var{y} can be a single string). In this case, string lookup\n\ -is performed using lexicographical comparison.\n\ -\n\ -If @var{opts} is specified, it must be a string with letters indicating\n\ -additional options.\n\ -\n\ -@table @code\n\ -@item m\n\ -@code{table(idx(i)) == val(i)} if @code{val(i)}\n\ -occurs in table; otherwise, @code{idx(i)} is zero.\n\ -\n\ -@item b\n\ -@code{idx(i)} is a logical 1 or 0, indicating whether\n\ -@code{val(i)} is contained in table or not.\n\ -\n\ -@item l\n\ -For numeric lookups\n\ -the leftmost subinterval shall be extended to infinity (i.e., all indices\n\ -at least 1)\n\ -\n\ -@item r\n\ -For numeric lookups\n\ -the rightmost subinterval shall be extended to infinity (i.e., all indices\n\ -at most n-1).\n\ -@end table\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{idx} =} lookup (@var{table}, @var{y}) +@deftypefnx {} {@var{idx} =} lookup (@var{table}, @var{y}, @var{opt}) +Lookup values in a sorted table. + +This function is usually used as a prelude to interpolation. + +If table is increasing and @code{idx = lookup (table, y)}, then +@code{table(idx(i)) <= y(i) < table(idx(i+1))} for all @code{y(i)} within +the table. If @code{y(i) < table(1)} then @code{idx(i)} is 0. If +@code{y(i) >= table(end)} or @code{isnan (y(i))} then @code{idx(i)} is +@code{n}. + +If the table is decreasing, then the tests are reversed. +For non-strictly monotonic tables, empty intervals are always skipped. +The result is undefined if @var{table} is not monotonic, or if +@var{table} contains a NaN. + +The complexity of the lookup is O(M*log(N)) where N is the size of +@var{table} and M is the size of @var{y}. In the special case when @var{y} +is also sorted, the complexity is O(min(M*log(N),M+N)). + +@var{table} and @var{y} can also be cell arrays of strings +(or @var{y} can be a single string). In this case, string lookup +is performed using lexicographical comparison. + +If @var{opts} is specified, it must be a string with letters indicating +additional options. + +@table @code +@item m +@code{table(idx(i)) == val(i)} if @code{val(i)} +occurs in table; otherwise, @code{idx(i)} is zero. + +@item b +@code{idx(i)} is a logical 1 or 0, indicating whether +@code{val(i)} is contained in table or not. + +@item l +For numeric lookups +the leftmost subinterval shall be extended to infinity (i.e., all indices +at least 1) + +@item r +For numeric lookups +the rightmost subinterval shall be extended to infinity (i.e., all indices +at most n-1). +@end table +@end deftypefn */) { int nargin = args.length ();