Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pzaino/gods
GoDS is just a Go Lang library of Datastructures I created for my own projects and to practice some generic programming in go
https://github.com/pzaino/gods
algorithms buffer circular-buffer data-structures doubly-linked-list go golang linked-list priority-queue queues stack
Last synced: about 1 month ago
JSON representation
GoDS is just a Go Lang library of Datastructures I created for my own projects and to practice some generic programming in go
- Host: GitHub
- URL: https://github.com/pzaino/gods
- Owner: pzaino
- License: apache-2.0
- Created: 2024-07-17T21:00:41.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-30T23:45:57.000Z (about 1 month ago)
- Last Synced: 2024-12-01T00:27:22.146Z (about 1 month ago)
- Topics: algorithms, buffer, circular-buffer, data-structures, doubly-linked-list, go, golang, linked-list, priority-queue, queues, stack
- Language: Go
- Homepage:
- Size: 685 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# GoDS (Go Data Structures)
[](https://goreportcard.com/report/github.com/pzaino/gods)
[](https://github.com/pzaino/gods/actions/workflows/go-vulncheck.yml)
[](https://app.codacy.com/gh/pzaino/gods/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fpzaino%2Fgods?ref=badge_shield&issueType=license)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fpzaino%2Fgods?ref=badge_shield&issueType=security)
[](https://github.com/pzaino/gods/actions/workflows/osv-scanner.yml/badge.svg)
**WIP**: This project is still a work in progress. I will be adding more data
structures as I implement them. Please do not use it yet, as it is not ready
for production.
This repository contains my implementations of various data structures in Go.
The data structures are implemented in two ways:
- Lockless: You can find these in the `pkg` directory with their "standard"
names, e.g., stack, linkedList.
- Concurrency-safe wrapper: You can find these in the `pkg` directory with the
prefix "cs", e.g., csstack, cslinkedList.
Use the non-concurrent-safe data structures if you need the best performance
in a non-concurrent application or if you want to handle concurrency yourself.
Use the concurrent-safe data structures for the best approach in concurrent
applications or if you prefer not to handle concurrency yourself.
Both implementations generally come with three special methods:
- `ConfinedForEach`: This method iterates over the data structure and executes
a function for each element. The function is executed in a separate goroutine
for each element.
- `ConfinedForFrom`: This method iterates over the data structure and executes
a function for each element starting from a given element. The function is
executed in a separate goroutine for each element.
- `ConfinedForRange`: This method iterates over the data structure and
executes a function for each element within a given range. The function is
executed in a separate goroutine for each element.
These three methods offer better performance when there are multiple CPU cores
available. They are also useful when you want to execute a function for each
element in parallel. The number of goroutines created will be equal to the
number of CPU cores available.
Every other method is not parallel. The Buffer has a special set of methods
called:
- `Blit`: This method combines/overwrites the elements of the buffer with the
elements of another buffer using a custom function. If the two buffers have
different lengths, the function will use the size of the smaller buffer.
- `BlitFrom`: This method combines/overwrites the elements of the buffer with
the elements of another buffer starting from a given index using a custom
function. If the two buffers have different lengths, the function will use
the size of the smaller buffer.
- `BlitRange`: This method combines/overwrites the elements of the buffer
with the elements of another buffer within a given range using a custom
function.
These functions are special because, for large amounts of data, they use
parallelism to speed up the process. The number of goroutines created will
be equal to the number of CPU cores available.
## Packaging and General Design
All data structures come with a set of tests to ensure that they work as
expected.
Each data structure is implemented as a separate package in the `pkg`
directory. The `cmd` directory contains a set of example programs that
demonstrate how to use the data structures.
This design should make it easy to use the data structures in your own
projects without significantly increasing your code size. You can simply
import the package you need and start using it.
All data structures are designed to use generics, so some method calls may
require you to provide a comparison function, hash function, etc.
## Installation / Usage
To use a library, you need to import it into your code. For example, to use
the stack data structure, you would do:
```go
import "github.com/pzaino/gods/pkg/stack"
```
Then you can start using the stack data structure in your code.
You can use more than one data structure in your code. Just import the ones
you need.
You may need to "install" the library first. To do that, use the following
command:
```bash
go get github.com/pzaino/gods
```
This will download the library and install it in your `$GOPATH`.
## Data Structures
- [x] [Stack](./pkg/stack)
- [x] [Concurrent Stack](./pkg/csstack)
- [x] [Buffer](./pkg/buffer)
- [x] [Concurrent Buffer](./pkg/csbuffer)
- [ ] [Ring Buffer](./pkg/ringBuffer)
- [ ] [Concurrent Ring Buffer](./pkg/csringBuffer)
- [ ] [A/B Buffer](./pkg/abBuffer)
- [ ] [Concurrent A/B Buffer](./pkg/csabBuffer)
- [x] [Queue](./pkg/queue)
- [ ] [Concurrent Queue](./pkg/csqueue)
- [x] [Priority Queue](./pkg/pqueue)
- [ ] [Concurrent Priority Queue](./pkg/cspqueue)
- [x] [Linked List](./pkg/linkList)
- [x] [Concurrent Linked List](./pkg/cslinkList)
- [x] [Doubly Linked List](./pkg/dlinkList)
- [x] [Concurrent Doubly Linked List](./pkg/csdlinkList)
- [x] [Circular Linked List](./pkg/circularLinkList)
- [ ] [Concurrent Circular Linked List](./pkg/cscircularLinkList)
- [ ] [Binary Search Tree](./pkg/binarySearchTree)
- [ ] [AVL Tree](./pkg/avlTree)
- [ ] [Trie](./pkg/trie)
- [ ] [Graph](./pkg/graph)
- [ ] [Disjoint Set](./pkg/disjointSet)
- [ ] [Segment Tree](./pkg/segmentTree)
- [ ] [Fenwick Tree](./pkg/fenwickTree)
Legend:
- [x] Implemented
- [ ] Not implemented yet (WIP)
Given that this project is still a WIP, I may change the APIs as I move forward
with the work. I will try to keep the changes to a minimum and make them as
easy to adapt to as possible. However, I also want to achieve a good design.
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fpzaino%2Fgods?ref=badge_large)