spart 0.1.3

A collection of space partitioning tree data structures for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

## Spart

[<img alt="tests" src="https://img.shields.io/github/actions/workflow/status/habedi/spart/tests.yml?label=tests&style=flat&logo=github" height="20">](https://github.com/habedi/spart/actions/workflows/tests.yml)
[<img alt="lints" src="https://img.shields.io/github/actions/workflow/status/habedi/spart/lints.yml?label=lints&style=flat&logo=github" height="20">](https://github.com/habedi/spart/actions/workflows/lints.yml)
[<img alt="code coverage" src="https://img.shields.io/codecov/c/github/habedi/spart?style=flat&logo=codecov" height="20">](https://codecov.io/gh/habedi/spart)
[<img alt="codefactor" src="https://img.shields.io/codefactor/grade/github/habedi/spart?style=flat&logo=codefactor" height="20">](https://www.codefactor.io/repository/github/habedi/spart)
[<img alt="crates.io" src="https://img.shields.io/crates/v/spart.svg?label=crates.io&style=flat&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/spart)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-spart-66c2a5?label=docs.rs&style=flat&logo=docs.rs" height="20">](https://docs.rs/spart)
[<img alt="downloads" src="https://img.shields.io/crates/d/spart?label=downloads&style=flat&logo=rust" height="20">](https://crates.io/crates/spart)
[<img alt="msrv" src="https://img.shields.io/badge/msrv-1.83.0-orange?label=msrv&style=flat&logo=rust" height="20">](https://github.com/rust-lang/rust/releases/tag/1.83.0)
[<img alt="docs" src="https://img.shields.io/badge/docs-latest-3776ab?label=docs&style=flat&logo=readthedocs" height="20">](docs)
[<img alt="license" src="https://img.shields.io/badge/license-mit%2Fapache--2.0-007ec6?label=license&style=flat&logo=open-source-initiative" height="20">](https://github.com/habedi/spart)

Spart (**s**[pace] **par**[titioning] **t**[rees] is a Rust library that provides implementations of various
space partitioning tree data structures for efficient indexing and searching 2D and 3D point data.

Currently, the following trees are implemented:

| Index | Tree Type                                          | 2D | 3D | kNN Search | Range Search |
|-------|----------------------------------------------------|----|----|------------|--------------|
| 1     | [Quadtree](https://en.wikipedia.org/wiki/Quadtree) | ✓  |    | ✓          | ✓            |
| 2     | [Octree](https://en.wikipedia.org/wiki/Octree)     |    | ✓  | ✓          | ✓            |
| 3     | [Kd-tree](https://en.wikipedia.org/wiki/K-d_tree)  | ✓  | ✓  | ✓          | ✓            |
| 4     | [R-tree](https://en.wikipedia.org/wiki/R-tree)     | ✓  | ✓  | ✓          | ✓            |
| 5     | [BSP-tree](https://en.wikipedia.org/wiki/BSP-tree) | ✓  | ✓  | ✓          | ✓            |

### Installation

```bash
cargo add spart
```

*Spart requires Rust 1.83.0 or later.*

### Documentation

The documentation for the latest release can be found [here](docs).

Additionally, check out the [tests](tests/) directory for detailed examples for how to use the library.

### Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a contribution.

### License

Spart is available under the terms of either of the following licenses:

* MIT License ([LICENSE-MIT](LICENSE-MIT))
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE))