Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shirshendubhowmick/golang-data-structures
Popular data strctures & algorithms in Go lang
https://github.com/shirshendubhowmick/golang-data-structures
data-structures datastructures go golang linked-list tree
Last synced: 18 days ago
JSON representation
Popular data strctures & algorithms in Go lang
- Host: GitHub
- URL: https://github.com/shirshendubhowmick/golang-data-structures
- Owner: shirshendubhowmick
- License: mit
- Created: 2020-09-16T18:37:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-05T19:26:21.000Z (over 3 years ago)
- Last Synced: 2024-12-10T03:07:22.326Z (about 1 month ago)
- Topics: data-structures, datastructures, go, golang, linked-list, tree
- Language: Go
- Homepage:
- Size: 43 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Golang Data Structures
Packages of commonly used data structures and algorithms. Supports go module.
[](https://github.com/shirshendubhowmick/golang-data-structures/actions/workflows/tests.yml)
## Note: This is a WIP project, contributions are welcomed.
## Table of contents
* [Quickstart](#Quickstart)
* [Installation](#Installation)
* [Directory structure](#Directory-structure)
* [Package contents](#Package-contents)
## Quickstart
```go
package main
import (
"fmt"
"github.com/shirshendubhowmick/golang-data-structures/pkg/linkedlist/sll"
)
func main() {
list := sll.InitList(4)
list.Append(5)
nodeRef0 := list.Append(6)
list.Append(7)
list.Append(8)
list.Prepend(3)
nodeRef1 := list.Prepend(2)
list.Prepend(1)
list.Prepend(0)
list.Print()
list.RemoveByIndex(4)
list.Print()
fmt.Println(list.Get(4))
fmt.Println(list.IndexOf(8))
list.ReplaceByIndex(7, 99)
list.Print()
fmt.Println(list.ToSlice())
fmt.Println(list.Length())
fmt.Println(list.InsertAt(8, 200))
list.Print()
_, nodeRef2, _ := list.ReplaceByNode(nodeRef1, 999)
list.Print()
list.RemoveByNode(nodeRef2)
list.Print()
list.InsertAfter(nodeRef0, 500)
list.Print()
list.InsertBefore(nodeRef0, 600)
list.Print()
}
```
## Installation
This was developved in go `v1.15` and not tested in any other lower version as of now.
Inside your main module run
```bash
go get github.com/shirshendubhowmick/golang-data-structures/pkg
```
## Directory structure
This repo uses go modules, `pkg` is the module directory and it contains all the packages.
Packages are distributed based on their data structure.
For example
`pkg/linkedlist` contains packages `sll`, `dll` etc
`pkg/tree` contains packages `btree`, `avltree` etc
Any packages inside an `internal` directory are meant for internal use, do not consume them directly.
Examples are located in `examples` directory, they are also distributed in the same way as packages.
For example
`examples/linkedList` directory contains all examples related to linked lists
## Package contents
* [**Linked lists**](#Linked-lists)
* [Singly linked list](#Singly-linked-list)
* [Doubly linked list](#Doubly-linked-list)
* Circular linked list
* **Stack**
* Array stack
* Linked list stack
* **Queue**
* Normal queue
* Priority queue
* Deque
* Circular queue
* **Tree**
* Binary search tree
* AVL tree
* B Tree
Many more coming soon...
## Linked lists
All linked lists uses type `interface {}` for the payload, as the list allows any type of data to be stored and also internally it doesn't perform any operations on the payload.
It is recommended that consumer of linked lists define a proper type to the payload, to have compile time type safety. As it is expected that consumers are going to perform operations on the payload.
* ### Singly linked list
Package location:
`github.com/shirshendubhowmick/golang-data-structures/pkg/linkedlist/sll`
[See examples](examples/linkedList/singlyLinkedList/)
[Package README](pkg/linkedlist/sll)
* ### Doubly linked list
Package location:
`github.com/shirshendubhowmick/golang-data-structures/pkg/linkedlist/dll`
[See examples](examples/linkedList/doublyLinkedList/)
[Package README](pkg/linkedlist/sll)
#### Note: Detailed documentation WIP