2
# @(#) $Revision: 4.17 $ $Source: /judy/README $
6
#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
9
To build and install Judy, see the INSTALL file.
12
#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
18
# This tree contains sources, documents, tests, and tools for the Judy package.
19
# This file is in a form that can be validated using the tool/readme script.
21
# NOTE: The README files here describe some files that are not included in
22
# every Judy source package.
25
# WHAT IS JUDY? (see below for list of top-level directories and files)
27
# Judy is a C library that implements a dynamic array. Empty Judy arrays are
28
# declared with null pointers. A Judy array consumes memory only when
29
# populated yet can grow to take advantage of all available memory. Judy's key
30
# benefits are: scalability, performance, memory efficiency, and ease of use.
31
# Judy arrays are designed to grow without tuning into the peta-element range,
32
# scaling near O(log-base-256).
34
# Judy arrays are accessed with insert, retrieve, and delete calls for number
35
# or string indexes. Configuration and tuning are not required -- in fact not
36
# possible. Judy offers sorting, counting, and neighbor/empty searching.
37
# Indexes can be sequential, clustered, periodic, or random -- it doesn't
38
# matter to the algorithm. Judy arrays can be arranged hierarchically to
39
# handle any bit patterns -- large indexes, sets of keys, etc.
41
# Judy is often an improvement over common data structures such as: arrays,
42
# sparse arrays, hash tables, B-trees, binary trees, linear lists, skiplists,
43
# other sort and search algorithms, and counting functions.
46
# JUDY TOP DIRECTORY CONTENTS:
49
INSTALL Summary instructions to build, install, and check Judy.
50
COPYING Judy deliverable license notice (the LGPL).
52
Makefile.multi Multi-platform, multi-flavor Judy makefile that knows how to
53
make all deliverables and a few other files, but not all Judy
54
constructed files, especially tests.
56
make_includes/ Makefile fragments included by Makefile.multi.
58
configure Simple script to wrap around makefile, a placeholder for a
59
"real" configure script generated by autoconf; see comments
62
makeall Reminder how to make all (multi-platform) useful Judy
63
files/targets as developer in mounted sandboxes on
66
src/ Header and source files used to build the package.
67
doc/ Documents, both external (to the package) and internal.
69
tool/ judy-specific tools.
added
removed
README
