man/lispref/range-tables.texi

   1 @c -*-texinfo-*-
   2 @c This is part of the XEmacs Lisp Reference Manual.
   3 @c Copyright (C) 1996 Ben Wing.
   4 @c See the file lispref.texi for copying conditions.
   5 @setfilename ../../info/range-tables.info
   6 @node Range Tables, Databases, Hash Tables, top
   7 @chapter Range Tables
   8 @cindex Range Tables
   9
  10 A range table is a table that efficiently associated values with
  11 ranges of integers.
  12
  13 Note that range tables have a read syntax, like this:
  14
  15 @example
  16 #s(range-table data ((-3 2) foo (5 20) bar))
  17 @end example
  18
  19 This maps integers in the range (-3, 2) to @code{foo} and integers
  20 in the range (5, 20) to @code{bar}.
  21
  22 @defun range-table-p object
  23 Return non-@code{nil} if @var{object} is a range table.
  24 @end defun
  25
  26 @menu
  27 * Introduction to Range Tables:: Range tables efficiently map ranges of
  28                                  integers to values.
  29 * Working With Range Tables::    Range table functions.
  30 @end menu
  31
  32 @node Introduction to Range Tables
  33 @section Introduction to Range Tables
  34
  35 @defun make-range-table
  36 Make a new, empty range table.
  37 @end defun
  38
  39 @defun copy-range-table range-table
  40 This function returns a new range table which contains the same values
  41 for the same ranges as @var{range-table}.  The values will not
  42 themselves be copied.
  43 @end defun
  44
  45 @node Working With Range Tables
  46 @section Working With Range Tables
  47
  48 @defun get-range-table pos range-table &optional default
  49 This function finds value for position @var{pos} in @var{range-table}.
  50 If there is no corresponding value, return @var{default} (defaults to
  51 @code{nil}).
  52 @end defun
  53
  54 @defun put-range-table start end value range-table
  55 This function sets the value for range (@var{start}, @var{end}) to be
  56 @var{value} in @var{range-table}.
  57 @end defun
  58
  59 @defun remove-range-table start end range-table
  60 This function removes the value for range (@var{start}, @var{end}) in
  61 @var{range-table}.
  62 @end defun
  63
  64 @defun clear-range-table range-table
  65 This function flushes @var{range-table}.
  66 @end defun
  67
  68 @defun map-range-table function range-table
  69 This function maps @var{function} over entries in @var{range-table},
  70 calling it with three args, the beginning and end of the range and the
  71 corresponding value.
  72 @end defun
  73