TPR-Tree index source code
==========================

Version
-------
 
This is version 1.1 of the code. Comparing to the previous release a
few bugs were fixed (see bug_fixes.txt) and the code was ported to gcc
3.3.1 compiler.

Contents
--------

This source code distribution includes: 

README            - this file 
command.help      - short documentation of index testbed commands 
Makefile          - Makefile to compile all source 
libGiST/          - GiST library source code
index/            - source code of the index and the experimental testbed
libxfig/          - source code of a tiny library used for simple visualization 
generate/         - source code of the moving-objects workload generator
generate/README   - short documentation of the moving-objects workload generator
generate/prm      - workload generation parameter files used in experimental studies 
test/             - a small example for testing the generator and the testbed

GiST is a Generalized Search Tree class library. Provided GiST is a
substantially revised version of libGiST version 0.9beta1, copyright
(c) 1996, Regents of the University of California.

The TPR-tree code is based on the paper "Indexing the Positions of
Continuously Moving Objects," by S. Saltenis, C. S. Jensen,
S. T. Leutenegger, and M. A. Lopez (SIGMOD'2000). In addition to the
implementation of the TPR-tree, TPR-tree with load-time bounding
rectangles, and R-tree, the source code provides a number of different
variants of algorithms. The generate/prm/ directory contains the
parameter files for the moving-objects workload generator. These files
were used when generating the workloads for the experiments described
in the SIGMOD paper.

The commands of the testbed are briefly described in command.help 

To compile all source code run make in the main directory. Four
separate makes will be invoked---one for building libGiST, one for
building libxfig, one for building the experimental testbed (directory
index), and one for building the workload generator (directory
generate). For successful build, it may be necessary to update the
paths of include and library directories in the Makefiles (macro
definitions INCS and LIBS). The source code should be compilable with
GNU C++ version 3.3.1 and later. The source code, as is, is not
guaranteed to compile with any other C++ compilers.

To test the generator, the indexes, and the testbed go to test/ and
run the executables as described in test/README.
 
This release is available at http://www.cs.auc.dk/~simas/tpr/tpr1.1.tar.gz

Disclaimer
----------

The provided code base evolved during a substantial period of time and
only the core part of the functionality (corresponding to what is
described in the SIGMOD paper) was tested before this
release. Comments and bug reports are very welcome and should be sent
to simas@cs.auc.dk.

Acknowledgments
---------------

Parts of the STR and Hilbert bulkloading algorithms are based on code
kindly provided by Yvan Garcia. Libxfig library is by Kazuo
Amano. Mindaugas Pelanis corrected a number of bugs in workload
generator.

July 2001 and April 2005, Aalborg

Copyright (c) 2001, 2005, Aalborg University