golang-data-structures

README

Golang Data Structures

Packages of commonly used data structures and algorithms. Supports go module.

Note: This is a WIP project, contributions are welcomed.

Table of contents

• Quickstart
• Installation
• Directory structure
• Package contents

Quickstart

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

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

  • Singly 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

  Package README

• Doubly linked list

  Package location: github.com/shirshendubhowmick/golang-data-structures/pkg/linkedlist/dll

  See examples

  Package README

Note: Detailed documentation WIP