https://github.com/austingebauer/go-treap
A Go library that provides a balanced binary search tree by using binary heap properties and randomization.
https://github.com/austingebauer/go-treap
Last synced: 10 months ago
JSON representation
A Go library that provides a balanced binary search tree by using binary heap properties and randomization.
- Host: GitHub
- URL: https://github.com/austingebauer/go-treap
- Owner: austingebauer
- License: mit
- Created: 2019-12-17T20:18:49.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-30T07:05:55.000Z (about 6 years ago)
- Last Synced: 2025-02-08T20:23:55.552Z (12 months ago)
- Language: Go
- Size: 31.3 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-treap [](https://goreportcard.com/report/github.com/austingebauer/go-treap) [](https://godoc.org/github.com/austingebauer/go-treap)
A Go library that provides a balanced binary search tree
by using binary heap properties and randomization.
The height of the treap is proportional to the logarithm of the number
of values inserted with high probability. This characteristic means that,
on average, each `Search()`, `Insert()`, or `Delete()` operation takes logarithmic
time to perform.
## Installation
To install `go-treap`, use `go get`.
```bash
go get github.com/austingebauer/go-treap
```
Then import the library into your Go program.
```go
import "github.com/austingebauer/go-treap"
```
## Usage
### API
The `go-treap` API provides `Search()`, `Insert()`, and `Delete()` functions with
`O(log n)` time complexity on average.
Please refer to the [GoDoc](https://godoc.org/github.com/austingebauer/go-treap) for
additional API documentation of the library.
**Example 1**: Basic usage
```go
trp := NewTreap()
trp.Insert("c")
trp.Insert("b")
trp.Insert("a")
trp.Search("a") // true
trp.Search("d") // false
trp.Delete("b")
trp.Delete("c")
trp.Delete("a")
```
### Behavior
I recommend reading [Julia Evan's Blog Post on Treaps](https://jvns.ca/blog/2017/09/09/data-structure--the-treap-/)
for a simple explanation of the treap data structure.
## Contributing
Pull requests are welcome.
For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests along with changes.
## License
[MIT](LICENSE)