Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fogfish/skiplist
Golang SkipList data structure
https://github.com/fogfish/skiplist
data-structures golang skiplist
Last synced: about 2 months ago
JSON representation
Golang SkipList data structure
- Host: GitHub
- URL: https://github.com/fogfish/skiplist
- Owner: fogfish
- License: mit
- Created: 2022-10-06T18:35:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-03T17:39:45.000Z (over 1 year ago)
- Last Synced: 2024-10-18T16:24:16.898Z (4 months ago)
- Topics: data-structures, golang, skiplist
- Language: Go
- Homepage:
- Size: 40 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Skip List
probabilistic, mutable list-based data structure
---
Package `skiplist` implements a probabilistic, mutable list-based data structure that are a simple and efficient substitute for balanced trees. The algorithm is well depicted by [the article](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.17.524).
## Inspiration
The library provides generic implementation of
* `skiplist.Set[K]` ordered set of elements
* `skiplist.Map[K]` ordered set of key, value pairs
* `skiplist.GF2[K]` finite field on modulo 2
For each of the data type it standardize interfaces around
```go
// Set behavior trait
type Set[K skiplist.Key] interface {
Add(K) bool
Has(K) bool
Cut(K) bool
Values(K) *Element[K]
Successors(K) *Element[K]
Split(K) Set[K]
}
// Map (Key, Value) pairs behavior trait
type Map[K skiplist.Key, V any] interface {
Put(K, V) bool
Get(K) (V, bool)
Cut(K) (V, bool)
Keys(K) *Element[K]
Successors(K) *Element[K]
Split(K) Map[K, V]
}
```
## Installing
The latest version of the library is available at `main` branch. All development, including new features and bug fixes, take place on the `main` branch using forking and pull requests as described in contribution guidelines. The stable version is available via Golang modules.
1. Use `go get` to retrieve the library and add it as dependency to your application.
```bash
go get github.com/fogfish/skiplist@latest
```
2. Import it in your code
```go
import (
"github.com/fogfish/skiplist"
)
```
## Quick Example
Here is a minimal example on creating an instance of the `skiplist.Map`. See the full [example](examples)
```go
package main
import (
"github.com/fogfish/skiplist"
)
func main() {
kv := skiplist.NewMap[int, string]()
kv.Put(5, "instance")
kv.Get(5)
kv.Cut(5)
}
```
## How To Contribute
The library is [MIT](LICENSE) licensed and accepts contributions via GitHub pull requests:
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
The build and testing process requires [Go](https://golang.org) latest version.
**Build** and **run** in your development console.
```bash
git clone https://github.com/fogfish/skiplist
cd skiplist
go test
go test -run=^$ -bench=. -cpu 1
go test -fuzz=FuzzSetAddCut
go test -fuzz=FuzzMapIntPutGet
go test -fuzz=FuzzMapStringPutGet
go test -fuzz=FuzzGF2
```
### commit message
The commit message helps us to write a good release note, speed-up review process. The message should address two question what changed and why. The project follows the template defined by chapter [Contributing to a Project](http://git-scm.com/book/ch5-2.html) of Git book.
### bugs
If you experience any issues with the library, please let us know via [GitHub issues](https://github.com/fogfish/skiplist/issue). We appreciate detailed and accurate reports that help us to identity and replicate the issue.
## License
[](LICENSE)