1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
|
package graph
import (
"errors"
"fmt"
)
type undirected[K comparable, T any] struct {
hash Hash[K, T]
traits *Traits
store Store[K, T]
}
func newUndirected[K comparable, T any](hash Hash[K, T], traits *Traits, store Store[K, T]) *undirected[K, T] {
return &undirected[K, T]{
hash: hash,
traits: traits,
store: store,
}
}
func (u *undirected[K, T]) Traits() *Traits {
return u.traits
}
func (u *undirected[K, T]) AddVertex(value T, options ...func(*VertexProperties)) error {
hash := u.hash(value)
prop := VertexProperties{
Weight: 0,
Attributes: make(map[string]string),
}
for _, option := range options {
option(&prop)
}
return u.store.AddVertex(hash, value, prop)
}
func (u *undirected[K, T]) Vertex(hash K) (T, error) {
vertex, _, err := u.store.Vertex(hash)
return vertex, err
}
func (u *undirected[K, T]) VertexWithProperties(hash K) (T, VertexProperties, error) {
vertex, prop, err := u.store.Vertex(hash)
if err != nil {
return vertex, VertexProperties{}, err
}
return vertex, prop, nil
}
func (u *undirected[K, T]) RemoveVertex(hash K) error {
return u.store.RemoveVertex(hash)
}
func (u *undirected[K, T]) AddEdge(sourceHash, targetHash K, options ...func(*EdgeProperties)) error {
if _, _, err := u.store.Vertex(sourceHash); err != nil {
return fmt.Errorf("could not find source vertex with hash %v: %w", sourceHash, err)
}
if _, _, err := u.store.Vertex(targetHash); err != nil {
return fmt.Errorf("could not find target vertex with hash %v: %w", targetHash, err)
}
//nolint:govet // False positive.
if _, err := u.Edge(sourceHash, targetHash); !errors.Is(err, ErrEdgeNotFound) {
return ErrEdgeAlreadyExists
}
// If the user opted in to preventing cycles, run a cycle check.
if u.traits.PreventCycles {
createsCycle, err := CreatesCycle[K, T](u, 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)
}
if err := u.addEdge(sourceHash, targetHash, edge); err != nil {
return fmt.Errorf("failed to add edge: %w", err)
}
return nil
}
func (u *undirected[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 := u.AddEdge(copyEdge(edge)); err != nil {
return fmt.Errorf("failed to add (%v, %v): %w", edge.Source, edge.Target, err)
}
}
return nil
}
func (u *undirected[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 = u.AddVertex(vertex, copyVertexProperties(properties)); err != nil {
return fmt.Errorf("failed to add vertex %v: %w", hash, err)
}
}
return nil
}
func (u *undirected[K, T]) Edge(sourceHash, targetHash K) (Edge[T], error) {
// In an undirected graph, since multigraphs aren't supported, the edge AB
// is the same as BA. Therefore, if source[target] cannot be found, this
// function also looks for target[source].
edge, err := u.store.Edge(sourceHash, targetHash)
if errors.Is(err, ErrEdgeNotFound) {
edge, err = u.store.Edge(targetHash, sourceHash)
}
if err != nil {
return Edge[T]{}, err
}
sourceVertex, _, err := u.store.Vertex(sourceHash)
if err != nil {
return Edge[T]{}, err
}
targetVertex, _, err := u.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
}
type tuple[K comparable] struct {
source, target K
}
func (u *undirected[K, T]) Edges() ([]Edge[K], error) {
storedEdges, err := u.store.ListEdges()
if err != nil {
return nil, fmt.Errorf("failed to get edges: %w", err)
}
// An undirected graph creates each edge twice internally: The edge (A,B) is
// stored both as (A,B) and (B,A). The Edges method is supposed to return
// one of these two edges, because from an outside perspective, it only is
// a single edge.
//
// To achieve this, Edges keeps track of already-added edges. For each edge,
// it also checks if the reversed edge has already been added - e.g., for
// an edge (A,B), Edges checks if the edge has been added as (B,A).
//
// These reversed edges are built as a custom tuple type, which is then used
// as a map key for access in O(1) time. It looks scarier than it is.
edges := make([]Edge[K], 0, len(storedEdges)/2)
added := make(map[tuple[K]]struct{})
for _, storedEdge := range storedEdges {
reversedEdge := tuple[K]{
source: storedEdge.Target,
target: storedEdge.Source,
}
if _, ok := added[reversedEdge]; ok {
continue
}
edges = append(edges, storedEdge)
addedEdge := tuple[K]{
source: storedEdge.Source,
target: storedEdge.Target,
}
added[addedEdge] = struct{}{}
}
return edges, nil
}
func (u *undirected[K, T]) UpdateEdge(source, target K, options ...func(properties *EdgeProperties)) error {
existingEdge, err := u.store.Edge(source, target)
if err != nil {
return err
}
for _, option := range options {
option(&existingEdge.Properties)
}
if err := u.store.UpdateEdge(source, target, existingEdge); err != nil {
return err
}
reversedEdge := existingEdge
reversedEdge.Source = existingEdge.Target
reversedEdge.Target = existingEdge.Source
return u.store.UpdateEdge(target, source, reversedEdge)
}
func (u *undirected[K, T]) RemoveEdge(source, target K) error {
if _, err := u.Edge(source, target); err != nil {
return err
}
if err := u.store.RemoveEdge(source, target); err != nil {
return fmt.Errorf("failed to remove edge from %v to %v: %w", source, target, err)
}
if err := u.store.RemoveEdge(target, source); err != nil {
return fmt.Errorf("failed to remove edge from %v to %v: %w", target, source, err)
}
return nil
}
func (u *undirected[K, T]) AdjacencyMap() (map[K]map[K]Edge[K], error) {
vertices, err := u.store.ListVertices()
if err != nil {
return nil, fmt.Errorf("failed to list vertices: %w", err)
}
edges, err := u.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 (u *undirected[K, T]) PredecessorMap() (map[K]map[K]Edge[K], error) {
return u.AdjacencyMap()
}
func (u *undirected[K, T]) Clone() (Graph[K, T], error) {
traits := &Traits{
IsDirected: u.traits.IsDirected,
IsAcyclic: u.traits.IsAcyclic,
IsWeighted: u.traits.IsWeighted,
IsRooted: u.traits.IsRooted,
}
clone := &undirected[K, T]{
hash: u.hash,
traits: traits,
store: newMemoryStore[K, T](),
}
if err := clone.AddVerticesFrom(u); err != nil {
return nil, fmt.Errorf("failed to add vertices: %w", err)
}
if err := clone.AddEdgesFrom(u); err != nil {
return nil, fmt.Errorf("failed to add edges: %w", err)
}
return clone, nil
}
func (u *undirected[K, T]) Order() (int, error) {
return u.store.VertexCount()
}
func (u *undirected[K, T]) Size() (int, error) {
size := 0
outEdges, err := u.AdjacencyMap()
if err != nil {
return 0, fmt.Errorf("failed to get adjacency map: %w", err)
}
for _, outEdges := range outEdges {
size += len(outEdges)
}
// Divide by 2 since every add edge operation on undirected graph is counted
// twice.
return size / 2, nil
}
func (u *undirected[K, T]) edgesAreEqual(a, b Edge[T]) bool {
aSourceHash := u.hash(a.Source)
aTargetHash := u.hash(a.Target)
bSourceHash := u.hash(b.Source)
bTargetHash := u.hash(b.Target)
if aSourceHash == bSourceHash && aTargetHash == bTargetHash {
return true
}
if !u.traits.IsDirected {
return aSourceHash == bTargetHash && aTargetHash == bSourceHash
}
return false
}
func (u *undirected[K, T]) addEdge(sourceHash, targetHash K, edge Edge[K]) error {
err := u.store.AddEdge(sourceHash, targetHash, edge)
if err != nil {
return err
}
rEdge := Edge[K]{
Source: edge.Target,
Target: edge.Source,
Properties: EdgeProperties{
Weight: edge.Properties.Weight,
Attributes: edge.Properties.Attributes,
Data: edge.Properties.Data,
},
}
err = u.store.AddEdge(targetHash, sourceHash, rEdge)
if err != nil {
return err
}
return nil
}
|