README.md

Simple rstar Tutorial

rstar is an implementation of R^*-tree. The data structure stores spatial data such as points and lines efficiently. This tutorial serves as a quick start for rstar. We try to keep each part of the tutorial as simple as possible.

(The tutorial is for rstar version 0.12.0.)

Contents

• Setting Up
• Number Of Elements
• Element Iterations
• Insertion
  • Inserting One Element At A Time
  • Inserting Elements In A Batch
• Useful Queries
  • Existence Queries
  • Nearest Neighbor Queries
  • Nearest Neighbor Iterations
  • Range Queries
• Data Types
  • Points
  • Lines
  • Rectangles
  • Associating Data
• Other Queries
  • Shooting Elements
  • Rectangle Queries
  • Tree Intersections
• Removal
  • Removing An Element
  • Removing Multiple Elements
• Support For Serde
• Custom Data Types
• Custom Distances

See Also

• rstar - the spatial index.
• R^*-tree - an explanation of R^*-tree.

Contributions

Pull requests for typos, incorrect information, or other ideas are welcome!

License

All code in the tutorial is provided under the MIT License.