graph

Documentation

Overview

Package graph implements a simple graph data structure and supporting API to allow implementing graph alogirthms on top.

Example (Usage)

Creates a simple graph, and prints the degree of each vertex.

package main

import (
	"fmt"

	"gopkg.in/karalabe/cookiejar.v2/graph"
)

func main() {
	// Create a star shaped 5 vertex graph
	g := graph.New(5)
	g.Connect(0, 2)
	g.Connect(0, 3)
	g.Connect(1, 3)
	g.Connect(1, 4)
	g.Connect(2, 4)

	// For each vertex, count the outgoing edges
	for v := 0; v < g.Vertices(); v++ {
		degree := 0
		g.Do(v, func(peer interface{}) {
			degree++
		})
		fmt.Printf("%v: %v\n", v, degree)
	}
}

Output:

0: 2
1: 2
2: 2
3: 2
4: 2

Index

• type Graph
  • func New(vertices int) *Graph
  • func (g *Graph) Assign(id int, data interface{})
  • func (g *Graph) Connect(a, b int)
  • func (g *Graph) Disconnect(a, b int)
  • func (g *Graph) Do(v int, f func(interface{}))
  • func (g *Graph) Retrieve(id int) interface{}
  • func (g *Graph) Vertices() int

Examples

• Package (Usage)

Types

type Graph

type Graph struct {
	// contains filtered or unexported fields
}

Data structure for representing a graph.

func New

func New(vertices int) *Graph

Creates a new undirected graph.

func (*Graph) Assign

func (g *Graph) Assign(id int, data interface{})

Assigns some data to a graph node.

func (*Graph) Connect

func (g *Graph) Connect(a, b int)

Connects two vertices of a graph (may be a loopback).

func (*Graph) Disconnect

func (g *Graph) Disconnect(a, b int)

Disconnects two vertices of a graph (may be a loopback).

func (*Graph) Do

func (g *Graph) Do(v int, f func(interface{}))

Executes a function for every neighbor of a vertex.

func (*Graph) Retrieve

func (g *Graph) Retrieve(id int) interface{}

Retrieves the data associated with a graph node.

func (*Graph) Vertices

func (g *Graph) Vertices() int

Returns the number of vertices in the graph.