Skip to content

removes duplication of un/directed implementations #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

removes duplication of un/directed implementations #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
308 changes: 19 additions & 289 deletions directed.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,315 +1,45 @@
package graph

import (
"errors"
"fmt"
)

type directed[K comparable, T any] struct {
hash Hash[K, T]
traits *Traits
store Store[K, T]
graph[K, T]
}

func newDirected[K comparable, T any](hash Hash[K, T], traits *Traits, store Store[K, T]) *directed[K, T] {
traits.IsDirected = true
return &directed[K, T]{
hash: hash,
traits: traits,
store: store,
}
}

func (d *directed[K, T]) Traits() *Traits {
return d.traits
}

func (d *directed[K, T]) AddVertex(value T, options ...func(*VertexProperties)) error {
hash := d.hash(value)
properties := VertexProperties{
Weight: 0,
Attributes: make(map[string]string),
}

for _, option := range options {
option(&properties)
graph: graph[K, T]{
hash: hash,
traits: traits,
store: store,
},
}

return d.store.AddVertex(hash, value, properties)
}

func (d *directed[K, T]) AddVerticesFrom(g Graph[K, T]) error {
adjacencyMap, err := g.AdjacencyMap()
if err != nil {
return fmt.Errorf("failed to get adjacency map: %w", err)
}

for hash := range adjacencyMap {
vertex, properties, err := g.VertexWithProperties(hash)
if err != nil {
return fmt.Errorf("failed to get vertex %v: %w", hash, err)
}

if err = d.AddVertex(vertex, copyVertexProperties(properties)); err != nil {
return fmt.Errorf("failed to add vertex %v: %w", hash, err)
}
}

return nil
}

func (d *directed[K, T]) Vertex(hash K) (T, error) {
vertex, _, err := d.store.Vertex(hash)
return vertex, err
}

func (d *directed[K, T]) VertexWithProperties(hash K) (T, VertexProperties, error) {
vertex, properties, err := d.store.Vertex(hash)
if err != nil {
return vertex, VertexProperties{}, err
}

return vertex, properties, nil
}

func (d *directed[K, T]) RemoveVertex(hash K) error {
return d.store.RemoveVertex(hash)
}

func (d *directed[K, T]) AddEdge(sourceHash, targetHash K, options ...func(*EdgeProperties)) error {
_, _, err := d.store.Vertex(sourceHash)
if err != nil {
return fmt.Errorf("source vertex %v: %w", sourceHash, err)
}

_, _, err = d.store.Vertex(targetHash)
if err != nil {
return fmt.Errorf("target vertex %v: %w", targetHash, err)
}

if _, err := d.Edge(sourceHash, targetHash); !errors.Is(err, ErrEdgeNotFound) {
return ErrEdgeAlreadyExists
}
other := tograph(g)
return d.addVerticesFrom(&other)

// If the user opted in to preventing cycles, run a cycle check.
if d.traits.PreventCycles {
createsCycle, err := d.createsCycle(sourceHash, targetHash)
if err != nil {
return fmt.Errorf("check for cycles: %w", err)
}
if createsCycle {
return ErrEdgeCreatesCycle
}
}

edge := Edge[K]{
Source: sourceHash,
Target: targetHash,
Properties: EdgeProperties{
Attributes: make(map[string]string),
},
}

for _, option := range options {
option(&edge.Properties)
}

return d.addEdge(sourceHash, targetHash, edge)
}

func (d *directed[K, T]) AddEdgesFrom(g Graph[K, T]) error {
edges, err := g.Edges()
if err != nil {
return fmt.Errorf("failed to get edges: %w", err)
}

for _, edge := range edges {
if err := d.AddEdge(copyEdge(edge)); err != nil {
return fmt.Errorf("failed to add (%v, %v): %w", edge.Source, edge.Target, err)
}
}

return nil
}

func (d *directed[K, T]) Edge(sourceHash, targetHash K) (Edge[T], error) {
edge, err := d.store.Edge(sourceHash, targetHash)
if err != nil {
return Edge[T]{}, err
}

sourceVertex, _, err := d.store.Vertex(sourceHash)
if err != nil {
return Edge[T]{}, err
}

targetVertex, _, err := d.store.Vertex(targetHash)
if err != nil {
return Edge[T]{}, err
}

return Edge[T]{
Source: sourceVertex,
Target: targetVertex,
Properties: EdgeProperties{
Weight: edge.Properties.Weight,
Attributes: edge.Properties.Attributes,
Data: edge.Properties.Data,
},
}, nil
}

func (d *directed[K, T]) Edges() ([]Edge[K], error) {
return d.store.ListEdges()
other := tograph(g)
return d.addEdgesFrom(&other)
}

func (d *directed[K, T]) UpdateEdge(source, target K, options ...func(properties *EdgeProperties)) error {
existingEdge, err := d.store.Edge(source, target)
if err != nil {
return err
}

for _, option := range options {
option(&existingEdge.Properties)
}

return d.store.UpdateEdge(source, target, existingEdge)
}

func (d *directed[K, T]) RemoveEdge(source, target K) error {
if _, err := d.Edge(source, target); err != nil {
return err
}

if err := d.store.RemoveEdge(source, target); err != nil {
return fmt.Errorf("failed to remove edge from %v to %v: %w", source, target, err)
}

return nil
}

func (d *directed[K, T]) AdjacencyMap() (map[K]map[K]Edge[K], error) {
vertices, err := d.store.ListVertices()
if err != nil {
return nil, fmt.Errorf("failed to list vertices: %w", err)
}
_, err := d.updateEdge(source, target, options...)

edges, err := d.store.ListEdges()
if err != nil {
return nil, fmt.Errorf("failed to list edges: %w", err)
}

m := make(map[K]map[K]Edge[K], len(vertices))

for _, vertex := range vertices {
m[vertex] = make(map[K]Edge[K])
}

for _, edge := range edges {
m[edge.Source][edge.Target] = edge
}

return m, nil
}

func (d *directed[K, T]) PredecessorMap() (map[K]map[K]Edge[K], error) {
vertices, err := d.store.ListVertices()
if err != nil {
return nil, fmt.Errorf("failed to list vertices: %w", err)
}

edges, err := d.store.ListEdges()
if err != nil {
return nil, fmt.Errorf("failed to list edges: %w", err)
}

m := make(map[K]map[K]Edge[K], len(vertices))

for _, vertex := range vertices {
m[vertex] = make(map[K]Edge[K])
}

for _, edge := range edges {
if _, ok := m[edge.Target]; !ok {
m[edge.Target] = make(map[K]Edge[K])
}
m[edge.Target][edge.Source] = edge
}

return m, nil
}

func (d *directed[K, T]) addEdge(sourceHash, targetHash K, edge Edge[K]) error {
return d.store.AddEdge(sourceHash, targetHash, edge)
return err
}

func (d *directed[K, T]) Clone() (Graph[K, T], error) {
traits := &Traits{
IsDirected: d.traits.IsDirected,
IsAcyclic: d.traits.IsAcyclic,
IsWeighted: d.traits.IsWeighted,
IsRooted: d.traits.IsRooted,
PreventCycles: d.traits.PreventCycles,
}

clone := &directed[K, T]{
hash: d.hash,
traits: traits,
store: newMemoryStore[K, T](),
}

if err := clone.AddVerticesFrom(d); err != nil {
return nil, fmt.Errorf("failed to add vertices: %w", err)
}

if err := clone.AddEdgesFrom(d); err != nil {
return nil, fmt.Errorf("failed to add edges: %w", err)
}

return clone, nil
}

func (d *directed[K, T]) Order() (int, error) {
return d.store.VertexCount()
}

func (d *directed[K, T]) Size() (int, error) {
return d.store.EdgeCount()
}

func (d *directed[K, T]) edgesAreEqual(a, b Edge[T]) bool {
aSourceHash := d.hash(a.Source)
aTargetHash := d.hash(a.Target)
bSourceHash := d.hash(b.Source)
bTargetHash := d.hash(b.Target)

return aSourceHash == bSourceHash && aTargetHash == bTargetHash
}

func (d *directed[K, T]) createsCycle(source, target K) (bool, error) {
// If the underlying store implements CreatesCycle, use that fast path.
if cc, ok := d.store.(interface {
CreatesCycle(source, target K) (bool, error)
}); ok {
return cc.CreatesCycle(source, target)
gclone, err := d.clone()
if err != nil {
return nil, err
}

// Slow path.
return CreatesCycle(Graph[K, T](d), source, target)
}

// copyEdge returns an argument list suitable for the Graph.AddEdge method. This
// argument list is derived from the given edge, hence the name copyEdge.
//
// The last argument is a custom functional option that sets the edge properties
// to the properties of the original edge.
func copyEdge[K comparable](edge Edge[K]) (K, K, func(properties *EdgeProperties)) {
copyProperties := func(p *EdgeProperties) {
for k, v := range edge.Properties.Attributes {
p.Attributes[k] = v
}
p.Weight = edge.Properties.Weight
p.Data = edge.Properties.Data
dir := &directed[K, T]{
graph: *gclone,
}

return edge.Source, edge.Target, copyProperties
return dir, nil
}
4 changes: 0 additions & 4 deletions directed_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ func TestDirected_Traits(t *testing.T) {
traits *Traits
expected *Traits
}{
"default traits": {
traits: &Traits{},
expected: &Traits{},
},
"directed": {
traits: &Traits{IsDirected: true},
expected: &Traits{IsDirected: true},
Expand Down
Loading