annotate man/lispref/range-tables.texi @ 0:376386a54a3c r19-14

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