cgit.sxemacs.org Git - sxemacs/blob - info/lispref/range-tables.texi

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