https://github.com/dscyrescotti/rtree

A Swift implementation of R-Tree data structure for spatial indexing.
https://github.com/dscyrescotti/rtree

Last synced: about 1 month ago
JSON representation

A Swift implementation of R-Tree data structure for spatial indexing.

• Host: GitHub
• URL: https://github.com/dscyrescotti/rtree
• Owner: dscyrescotti
• License: mit
• Created: 2024-06-01T16:48:17.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-11-26T07:19:09.000Z (about 1 month ago)
• Last Synced: 2024-11-26T07:27:53.521Z (about 1 month ago)
• Language: Swift
• Homepage:
• Size: 11.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🌲 RTree

**RTree** implements [R-tree](https://en.wikipedia.org/wiki/R-tree) data structure in Swift for spatial indexing in a two-dimentional coordinate space.

## 💡 Features

**RTree** currently supports the following methods to manage 2D spatial data.

- [Retrieval](#retrieval)

- [Insertion](#insertion)

- [Removal](#removal)

- [Search](#search)

### Retrieval 

`traverse()` retrieves an array with all spatial data stored in the R-tree.

```swift

let rTree = RTree()

rTree.retrieve() // an array of integers

```

> Note: Please be aware that `traverse()` does not guarantee that the result will maintain the order of your insertion.

### Insertion 

A spatial data can be inserted into the R-tree using `insert(_:in:)`. It requires you to specify a bounding box as the spatial index.

```swift

let rTree = RTree()

let box = Box(minX: -10, minY: -10, maxX: 10, maxY: 10) // a bounding box

rTree.insert(0, in: box) // inserted at the spatial coordinate of (0, 0)

```

### Removal 

A spatial data can be removed from the R-tree using `remove(_:in:)` which returns the removed data if it is found in a specified boundary.

```swift

let rTree = RTree()

let box = Box(minX: -10, minY: -10, maxX: 10, maxY: 10) // a bounding box

rTree.remove(0, in: box) // removed

```

### Search 

`search(box:)` retrieves an array of some spatial data inside a specific bounding box within the R-tree.

```swift

let rTree = RTree()

let box = Box(minX: -10, minY: -10, maxX: 10, maxY: 10) // a bounding box

rTree.search(box: box) // an array of some spatial data

```

## 🛠 Installation 

### 📦 Using Swift Package Manager

Add it as a dependency within your Package.swift.

```swift

dependencies: [

    .package(url: "https://github.com/dscyrescotti/RTree.git", from: "1.0.0")

]

```

## © License

**RTree** is available under the MIT license. See the  [LICENSE](/LICENSE)  file for more info.