# RTree

**Repository Path**: leoZhangs/RTree

## Basic Information

- **Project Name**: RTree
- **Description**: 源于Github: https://github.com/nushoin/RTree
R-Trees: A Dynamic Index Structure for Spatial Searching
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-23
- **Last Updated**: 2025-09-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# R-Trees: A Dynamic Index Structure for Spatial Searching

## Description

A C++ templated version of [this](http://www.superliminal.com/sources/sources.htm)
RTree algorithm.
The code it now generally compatible with the STL and Boost C++ libraries.

## Usage

Include `RTree.h`. This library is header-only.

### Inserting

```cpp
#include "RTree.h"
typedef RTree<Foo*, double, 3> MyTree;

MyTree tree;
double min[3] = {0., 0., 0.};
double max[3] = {1., 1., 1.};
Foo* bar = new Foo();
tree.Insert(min, max, bar);
```

### Searching

```cpp
bool MySearchCallback(Foo* value)
{
	// do something with `value`, then
	// return `true` to keep going, return `false` to stop
	return true;
}

// search inside [0,0,0] and [1,1,1], execute callback on each hit
double min[3] = {0., 0., 0.};
double max[3] = {1., 1., 1.};
int nhits = tree.Search(min, max, MySearchCallback);
```

### Iterating

```cpp
MyTree::Iterator it;
for(tree.GetFirst(it); !tree.IsNull(it); tree.GetNext(it))
{
	Foo* value = tree.GetAt(it);

	double boundsMin[3] = {0., 0., 0.};
	double boundsMax[3] = {0., 0., 0.};
	// save bounds into boundsMin/Max
	it.GetBounds(boundsMin, boundsMax);
	cout << boundsMin[0] << "," << boundsMin[1] << "," << boundsMin[2] << ","
		<< boundsMax[0] << "," << boundsMax[1] << "," << boundsMax[2] << ")\n";
}
```

or

```cpp
MyTree::Iterator it;
tree.GetFirst(it);
while(!it.IsNull())
{
	Foo* value = *it;
	++it;
}
```


Listing all boxes in the tree, including the parent boxes that were not inserted
but form the RTree internally:

```cpp
auto list = tree.ListTree();
int counter = 0;
for (auto aabb : list) {
  cout << "TreeList [" << counter++ << "]: "
    << aabb.m_min[0] << ", "
    << aabb.m_min[1] << ", "
    << aabb.m_min[2] << "; "
    << aabb.m_max[0] << ", "
    << aabb.m_max[1] << ", "
    << aabb.m_max[2] << endl;
}
```


For working examples see
[the tests](https://github.com/nushoin/RTree/blob/master/tests).

## Testing

This uses CMake, which download GTest.

```bash
mkdir build
cd build
cmake -DENABLE_TESTING=ON ..
make
make test

# or

cmake -DENABLE_TESTING=ON -S . -B build
cmake --build build
cd build
ctest
```

Or use the IDE of your choice (tested with VSCode) and run the tests.

The RTree itself is a single header file and can be included without compiling.

## Authors

- 1983 Original algorithm and test code by Antonin Guttman and Michael Stonebraker, UC Berkely
- 1994 ANCI C ported from original test code by Melinda Green - melinda@superliminal.com
- 1995 Sphere volume fix for degeneracy problem submitted by Paul Brook
- 2004 Templated C++ port by Greg Douglas
- 2011 Modified the container to support more data types, by Yariv Barkan
- 2017 Modified Search to take C++11 function to allow lambdas and added const qualifier, by Gero Mueller

## License

Original code was taken from http://www.superliminal.com/sources/sources.htm 
and is stored as git revision 0. This revision is entirely free for all
uses. Enjoy!

Due to restrictions on public domain in certain jurisdictions, code
contributed by Yariv Barkan is released in these jurisdictions under the
BSD, MIT or the GPL - you may choose one or more, whichever that suits you
best.

In jurisdictions where public domain property is recognized, the user of
this software may choose to accept it either 1) as public domain, 2) under
the conditions of the BSD, MIT or GPL or 3) any combination of public
domain and one or more of these licenses.

Thanks [Baptiste Lepilleur](http://jsoncpp.sourceforge.net/LICENSE) for the
licensing idea.

## Recent Change Log

### 31 Jan 2018

- Added copy constructor
- Callback function is now `std::function`

### 05 Apr 2014

- Added tests

### 02 Sep 2011

- Modified the container to support more data types. The code it now generally
  compatible with the STL and Boost C++ libraries.

### 05 Jan 2010

- Fixed Iterator GetFirst() - Previous fix was not incomplete

### 03 Dec 2009

- Added Iteartor GetBounds()
- Added Iterator usage to simple test
- Fixed Iterator GetFirst() - Thanks Mathew Riek
- Minor updates for MSVC 2005/08 compilers