# rstar

**Repository Path**: happydpc/rstar

## Basic Information

- **Project Name**: rstar
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-13
- **Last Updated**: 2025-03-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/georust/rstar/test.yml?style=plastic)](#)
[![Docs](https://docs.rs/rstar/badge.svg)](https://docs.rs/rstar/)
[![Crates.io](https://img.shields.io/crates/v/rstar.svg)](https://crates.io/crates/rstar)
[![MIT/Apache](https://img.shields.io/crates/l/rustc-serialize.svg)](#license)

# rstar

A flexible, n-dimensional [r*-tree](https://en.wikipedia.org/wiki/R*_tree) implementation for the Rust ecosystem, suitable for use as a spatial index.

Please refer to the [crate README](rstar/README.md) for more information.

## r-tree

An r-tree is a data structure containing spatial data and is optimized for nearest neighbor search. Spatial data refers to an object that has the notion of a position and extent, for example points, lines and rectangles in any dimension.

## Geometries

Primitives are provided for point, line, and rectangle geometries. The [`geo`](https://crates.io/crates/geo) crate uses rstar as an efficient spatial index and provides [`RTreeObject`](file:///Users/sth/dev/rstar/target/doc/rstar/trait.RTreeObject.html) implementations for storing complex geometries such as linestrings and polygons.

# Demo
To run the rstar-demo, checkout the repository and run `cargo run rstar-demo` in the
repository root.
![Demo Image](rtree-example.png)

# License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.