source: trunk/sources/HeuristicLab.Core/3.3/Collections/DirectedGraph/DirectedGraph.cs @ 11241

Last change on this file since 11241 was 11241, checked in by mkommend, 8 years ago

#2223: Copied directed graph implented in bottom up tree distance branch into the trunk.

File size: 5.0 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Drawing;
25using System.Linq;
26using HeuristicLab.Common;
27using HeuristicLab.Common.Resources;
28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29
30namespace HeuristicLab.Core {
31  [Item("DirectedGraph", "Generic class representing a directed graph with custom vertices and content")]
32  [StorableClass]
33  public class DirectedGraph : Item, IDirectedGraph {
34    public override Image ItemImage { get { return VSImageLibrary.Graph; } }
35
36    private HashSet<IVertex> vertices;
37    [Storable]
38    public IEnumerable<IVertex> Vertices {
39      get { return vertices; }
40      private set { vertices = new HashSet<IVertex>(value); }
41    }
42
43    private HashSet<IArc> arcs;
44    [Storable]
45    public IEnumerable<IArc> Arcs {
46      get { return arcs; }
47      private set { arcs = new HashSet<IArc>(value); }
48    }
49
50    public DirectedGraph() {
51      vertices = new HashSet<IVertex>();
52      arcs = new HashSet<IArc>();
53    }
54
55    protected DirectedGraph(DirectedGraph original, Cloner cloner)
56      : base(original, cloner) {
57      vertices = new HashSet<IVertex>(original.vertices.Select(cloner.Clone));
58      arcs = new HashSet<IArc>(original.arcs.Select(cloner.Clone));
59    }
60
61    public override IDeepCloneable Clone(Cloner cloner) {
62      return new DirectedGraph(this, cloner);
63    }
64
65    [StorableConstructor]
66    protected DirectedGraph(bool serializing)
67      : base(serializing) {
68    }
69
70    [StorableHook(HookType.AfterDeserialization)]
71    private void AfterDeserialization() {
72      foreach (var vertex in vertices) {
73        vertex.ArcAdded += OnArcAdded;
74        vertex.ArcRemoved += OnArcRemoved;
75      }
76
77      foreach (var arc in arcs) {
78        var source = arc.Source;
79        var target = arc.Target;
80        source.AddArc(arc);
81        target.AddArc(arc);
82      }
83    }
84
85    public virtual void Clear() {
86      vertices.Clear();
87      arcs.Clear();
88    }
89
90    public virtual void AddVertex(IVertex vertex) {
91      vertices.Add(vertex);
92      // register event handlers
93      vertex.ArcAdded += OnArcAdded;
94      vertex.ArcRemoved += OnArcRemoved;
95    }
96
97    public virtual void RemoveVertex(IVertex vertex) {
98      vertices.Remove(vertex);
99      // remove connections to/from the removed vertex
100      var arcList = vertex.InArcs.Concat(vertex.OutArcs).ToList(); // avoid invalid operation exception: "collection was modified" below
101      foreach (var arc in arcList)
102        RemoveArc(arc);
103      // deregister event handlers
104      vertex.ArcAdded -= OnArcAdded;
105      vertex.ArcRemoved -= OnArcRemoved;
106    }
107
108    public virtual IArc AddArc(IVertex source, IVertex target) {
109      var arc = new Arc(source, target);
110      AddArc(arc);
111      return arc;
112    }
113
114    public virtual void AddArc(IArc arc) {
115      var source = (Vertex)arc.Source;
116      var target = (Vertex)arc.Target;
117      source.AddArc(arc);
118      target.AddArc(arc);
119      arcs.Add(arc);
120    }
121
122    public virtual void RemoveArc(IArc arc) {
123      arcs.Remove(arc);
124      var source = (Vertex)arc.Source;
125      var target = (Vertex)arc.Target;
126      source.RemoveArc(arc);
127      target.RemoveArc(arc);
128    }
129
130    public event EventHandler ArcAdded;
131    protected virtual void OnArcAdded(object sender, EventArgs<IArc> args) {
132      var arc = args.Value;
133      // the ArcAdded event is fired by a vertex when an arc from or towards another vertex is added to his list of connections
134      // because the arc is added in both directions by both the source and the target, this event will get fired twice
135      // here, we only want to add the arc once, so if its already contained, we return without complaining
136      if (arcs.Contains(arc)) return;
137      arcs.Add(arc);
138    }
139
140
141    public event EventHandler ArcRemoved;
142    protected virtual void OnArcRemoved(object sender, EventArgs<IArc> args) {
143      var arc = args.Value;
144      if (!arcs.Contains(arc)) return; // the same rationale as above
145      arcs.Remove(arc);
146    }
147
148    // events
149    public event EventHandler VertexAdded;
150    public event EventHandler VertexRemoved;
151  }
152}
Note: See TracBrowser for help on using the repository browser.