Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmdsefi/gograph
A golang generic graph library that provides mathematical graph-theory and algorithms.
https://github.com/hmdsefi/gograph
datastructure generic generic-graph golang graph graph-algorithms graph-datastructures graph-theory graph-traversal
Last synced: about 2 months ago
JSON representation
A golang generic graph library that provides mathematical graph-theory and algorithms.
- Host: GitHub
- URL: https://github.com/hmdsefi/gograph
- Owner: hmdsefi
- License: apache-2.0
- Created: 2022-07-28T16:54:30.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-01T11:37:29.000Z (4 months ago)
- Last Synced: 2024-08-01T21:27:41.962Z (4 months ago)
- Topics: datastructure, generic, generic-graph, golang, graph, graph-algorithms, graph-datastructures, graph-theory, graph-traversal
- Language: Go
- Homepage:
- Size: 147 KB
- Stars: 57
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - gograph - A golang generic graph library that provides mathematical graph-theory and algorithms. (Science and Data Analysis / HTTP Clients)
- zero-alloc-awesome-go - gograph - A golang generic graph library that provides mathematical graph-theory and algorithms. (Science and Data Analysis / HTTP Clients)
README
[](https://goreportcard.com/report/github.com/hmdsefi/gograph)
[](https://codecov.io/gh/hmdsefi/gograph)
[](https://pkg.go.dev/github.com/hmdsefi/gograph)
[](https://github.com/avelino/awesome-go#science-and-data-analysis)
# gograph
GoGraph is a lightweight, efficient, and easy-to-use graph data structure
implementation written in Go. It provides a versatile framework for representing
graphs and performing various operations on them, making it ideal for both
educational purposes and practical applications.
## Table of Contents
* [Install](#Install)
* [How to Use](#How-to-Use)
* [Graph](#Graph)
* [Directed](#Directed)
* [Acyclic](#Acyclic)
* [Undirected](#Undirected)
* [Weighted](#Weighted)
* [Traverse](#Traverse)
* [Connectivity](https://github.com/hmdsefi/gograph/tree/master/connectivity#gograph---connectivity)
* [Shortest Path]()
* [Dijkstra](https://github.com/hmdsefi/gograph/blob/master/path/dijkstra.md)
* [Bellman-Ford](https://github.com/hmdsefi/gograph/blob/master/path/bellman-ford.md)
* [Floyd-Warshall](https://github.com/hmdsefi/gograph/blob/master/path/floyd-warshall.md)
* [License](#License)
## Install
Use `go get` command to get the latest version of the `gograph`:
```shell
go get github.com/hmdsefi/gograph
```
Then you can use import the `gograph` to your code:
```go
package main
import "github.com/hmdsefi/gograph"
```
## How to Use
### Graph
`gograph` contains the `Graph[T comparable]` interface that provides all needed APIs to
manage a graph. All the supported graph types in `gograph` library implemented this interface.
```go
type Graph[T comparable] interface {
GraphType
AddEdge(from, to *Vertex[T], options ...EdgeOptionFunc) (*Edge[T], error)
GetAllEdges(from, to *Vertex[T]) []*Edge[T]
GetEdge(from, to *Vertex[T]) *Edge[T]
EdgesOf(v *Vertex[T]) []*Edge[T]
RemoveEdges(edges ...*Edge[T])
AddVertexByLabel(label T, options ...VertexOptionFunc) *Vertex[T]
AddVertex(v *Vertex[T])
GetVertexByID(label T) *Vertex[T]
GetAllVerticesByID(label ...T) []*Vertex[T]
GetAllVertices() []*Vertex[T]
RemoveVertices(vertices ...*Vertex[T])
ContainsEdge(from, to *Vertex[T]) bool
ContainsVertex(v *Vertex[T]) bool
}
```
The generic type of the `T` in `Graph` interface represents the vertex label. The type of `T`
should be comparable. You cannot use slices and function types for `T`.
#### Directed
```go
graph := New[int](gograph.Directed())
graph.AddEdge(gograph.NewVertex(1), gograph.NewVertex(2))
graph.AddEdge(gograph.NewVertex(1), gograph.NewVertex(3))
graph.AddEdge(gograph.NewVertex(2), gograph.NewVertex(2))
graph.AddEdge(gograph.NewVertex(3), gograph.NewVertex(4))
graph.AddEdge(gograph.NewVertex(4), gograph.NewVertex(5))
graph.AddEdge(gograph.NewVertex(5), gograph.NewVertex(6))
```
#### Acyclic
```go
graph := New[int](gograph.Directed())
graph.AddEdge(gograph.NewVertex(1), gograph.NewVertex(2))
graph.AddEdge(gograph.NewVertex(2), gograph.NewVertex(3))
_, err := graph.AddEdge(gograph.NewVertex(3), gograph.NewVertex(1))
if err != nil {
// do something
}
```
#### Undirected
```go
// by default graph is undirected
graph := New[string]()
graph.AddEdge(gograph.NewVertex("A"), gograph.NewVertex("B"))
graph.AddEdge(gograph.NewVertex("A"), gograph.NewVertex("D"))
graph.AddEdge(gograph.NewVertex("B"), gograph.NewVertex("C"))
graph.AddEdge(gograph.NewVertex("B"), gograph.NewVertex("D"))
```
#### Weighted
```go
graph := New[string]()
vA := gograph.AddVertexByLabel("A")
vB := gograph.AddVertexByLabel("B")
vC := gograph.AddVertexByLabel("C")
vD := gograph.AddVertexByLabel("D")
graph.AddEdge(vA, vB, gograph.WithEdgeWeight(4))
graph.AddEdge(vA, vD, gograph.WithEdgeWeight(3))
graph.AddEdge(vB, vC, gograph.WithEdgeWeight(3))
graph.AddEdge(vB, vD, gograph.WithEdgeWeight(1))
graph.AddEdge(vC, vD, gograph.WithEdgeWeight(2))
```
```go
graph := New[string]()
vA := gograph.AddVertexByLabel("A", gograph.WithVertexWeight(3))
vB := gograph.AddVertexByLabel("B", gograph.WithVertexWeight(2))
vC := gograph.AddVertexByLabel("C", gograph.WithVertexWeight(4))
graph.AddEdge(vA, vB)
graph.AddEdge(vB, vC)
```
### Traverse
Traverse package provides the iterator interface that guarantees all the algorithm export the same APIs:
```go
type Iterator[T comparable] interface {
HasNext() bool
Next() *gograph.Vertex[T]
Iterate(func(v *gograph.Vertex[T]) error) error
Reset()
}
```
This package contains the following iterators:
- [Breadth-First iterator](https://github.com/hmdsefi/gograph/tree/master/traverse#BFS)
- [Depth-First iterator](https://github.com/hmdsefi/gograph/tree/master/traverse#DFS)
- [Topological iterator](https://github.com/hmdsefi/gograph/tree/master/traverse#Topological-Sort)
- [Closest-First iterator](https://github.com/hmdsefi/gograph/tree/master/traverse#Closest-First)
- [Random Walk iterator](https://github.com/hmdsefi/gograph/tree/master/traverse#random-walk)
## License
Apache License, please see [LICENSE](https://github.com/hmdsefi/gograph/blob/master/LICENSE) for details.