https://github.com/fogarecious/rstar_tutorial

Tutorial of rstar
https://github.com/fogarecious/rstar_tutorial

rstar rust tutorial

Last synced: 10 months ago
JSON representation

Tutorial of rstar

• Host: GitHub
• URL: https://github.com/fogarecious/rstar_tutorial
• Owner: fogarecious
• Created: 2024-09-30T13:15:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-29T22:02:54.000Z (over 1 year ago)
• Last Synced: 2025-05-20T15:13:00.973Z (11 months ago)
• Topics: rstar, rust, tutorial
• Homepage:
• Size: 25.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Simple *rstar* Tutorial

[*rstar*](https://github.com/georust/rstar) is an implementation of [R*-tree](https://en.wikipedia.org/wiki/R*-tree).

The data structure stores spatial data such as points and lines efficiently.

This tutorial serves as a quick start for [*rstar*](https://github.com/georust/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](./tutorial/setting_up.md)

* [Number Of Elements](./tutorial/number_of_elements.md)

* [Element Iterations](./tutorial/element_iterations.md)

* Insertion

  * [Inserting One Element At A Time](./tutorial/inserting_one_element_at_a_time.md)

  * [Inserting Elements In A Batch](./tutorial/inserting_elements_in_a_batch.md)

* Useful Queries

  * [Existence Queries](./tutorial/existence_queries.md)

  * [Nearest Neighbor Queries](./tutorial/nearest_neighbor_queries.md)

  * [Nearest Neighbor Iterations](./tutorial/nearest_neighbor_iterations.md)

  * [Range Queries](./tutorial/range_queries.md)

* Data Types

  * [Points](./tutorial/points.md)

  * [Lines](./tutorial/lines.md)

  * [Rectangles](./tutorial/rectangles.md)

  * [Associating Data](./tutorial/associating_data.md)

* Other Queries

  * [Shooting Elements](./tutorial/shooting_elements.md)

  * [Rectangle Queries](./tutorial/rectangle_queries.md)

  * [Tree Intersections](./tutorial/tree_intersections.md)

* Removal

  * [Removing An Element](./tutorial/removing_an_element.md)

  * [Removing Multiple Elements](./tutorial/removing_multiple_elements.md)

* [Support For Serde](./tutorial/support_for_serde.md)

* [Custom Data Types](./tutorial/custom_data_types.md)

* [Custom Distances](./tutorial/custom_distances.md)

## See Also

* [*rstar*](https://github.com/georust/rstar) - the spatial index.

* [R*-tree](https://en.wikipedia.org/wiki/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.