Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s0rg/quadtree
Generic, zero-alloc, 100%-test covered Quadtree for golang
https://github.com/s0rg/quadtree
data-structures generics golang golang-library quadtree
Last synced: 25 days ago
JSON representation
Generic, zero-alloc, 100%-test covered Quadtree for golang
- Host: GitHub
- URL: https://github.com/s0rg/quadtree
- Owner: s0rg
- License: mit
- Created: 2022-09-08T15:15:22.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-02T20:17:43.000Z (over 1 year ago)
- Last Synced: 2024-07-31T20:48:17.332Z (4 months ago)
- Topics: data-structures, generics, golang, golang-library, quadtree
- Language: Go
- Homepage:
- Size: 23.4 KB
- Stars: 34
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - quadtree - Generic, zero-alloc, 100%-test covered quadtree. (Data Structures and Algorithms / Miscellaneous Data Structures and Algorithms)
- awesome-go - quadtree - Generic, zero-alloc, 100%-test covered quadtree. (Data Structures and Algorithms / Miscellaneous Data Structures and Algorithms)
README
[](https://pkg.go.dev/github.com/s0rg/quadtree)
[](https://github.com/s0rg/quadtree/blob/master/LICENSE)
[](go.mod)
[](https://github.com/s0rg/quadtree/tags)
[](https://github.com/avelino/awesome-go)
[](https://github.com/s0rg/quadtree/actions?query=workflow%3Aci)
[](https://goreportcard.com/report/github.com/s0rg/quadtree)
[](https://codeclimate.com/github/s0rg/quadtree/maintainability)
[](https://codeclimate.com/github/s0rg/quadtree/test_coverage)
# quadtree
[Quadtree](https://en.wikipedia.org/wiki/Quadtree) for golang.
# features
- generic
- heavy optimized
- zero-alloc
- 100% test coverage
# example
```go
import (
"log"
"github.com/s0rg/quadtree"
)
func main() {
// width, height and max depth for new tree
tree := quadtree.New[int](100.0, 100.0, 4)
// add some points
tree.Add(10.0, 10.0, 5.0, 5.0, 1)
tree.Add(15.0, 20.0, 10.0, 10.0, 2)
tree.Add(40.0, 10.0, 4.0, 4.0, 3)
tree.Add(90.0, 90.0, 5.0, 8.0, 4)
val, ok := tree.Get(9.0, 9.0, 11.0, 11.0)
if !ok {
log.Fatal("not found")
}
log.Println(val) // should print 1
const (
distance = 20.0
count = 2
)
tree.KNearest(80.0, 80.0, distance, count, func(x, y, w, h float64, val int) {
log.Printf("(%f, %f, %f, %f) = %d", x, y, w, h, val)
})
// output: (90.000000, 90.000000, 5.000000, 8.000000) = 4
}
```
# benchmark
```
goos: linux
goarch: amd64
pkg: github.com/s0rg/quadtree
cpu: AMD Ryzen 5 5500U with Radeon Graphics
BenchmarkNode/Insert-12 14974236 71.07 ns/op 249 B/op 0 allocs/op
BenchmarkNode/Del-12 6415672 188.3 ns/op 0 B/op 0 allocs/op
BenchmarkNode/Search-12 21702474 51.83 ns/op 0 B/op 0 allocs/op
BenchmarkTree/Add-12 18840514 67.83 ns/op 241 B/op 0 allocs/op
BenchmarkTree/Get-12 21204722 55.46 ns/op 0 B/op 0 allocs/op
BenchmarkTree/Move-12 8061322 147.5 ns/op 0 B/op 0 allocs/op
BenchmarkTree/ForEach-12 18723290 58.60 ns/op 0 B/op 0 allocs/op
BenchmarkTree/KNearest-12 3595956 324.7 ns/op 0 B/op 0 allocs/op
BenchmarkTree/Del-12 6234123 193.1 ns/op 0 B/op 0 allocs/op
PASS
ok github.com/s0rg/quadtree 12.666s
```