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

Last change on this file since 11263 was 11263, checked in by bburlacu, 8 years ago

#2223:

  • Vertex: remove cloning of arcs in the cloning constructor
  • DirectedGraph; Adjust cloning constructor to add arcs to cloned vertices
File size: 6.1 KB
RevLine 
[10267]1#region License Information
2/* HeuristicLab
[10278]3 * Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
[10267]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;
[11241]27using HeuristicLab.Common.Resources;
[10267]28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29
[11241]30namespace HeuristicLab.Core {
[10278]31  [Item("DirectedGraph", "Generic class representing a directed graph with custom vertices and content")]
[10267]32  [StorableClass]
[10300]33  public class DirectedGraph : Item, IDirectedGraph {
[11241]34    public override Image ItemImage { get { return VSImageLibrary.Graph; } }
35
36    private HashSet<IVertex> vertices;
[10267]37    [Storable]
[10903]38    public IEnumerable<IVertex> Vertices {
39      get { return vertices; }
[11229]40      private set { vertices = new HashSet<IVertex>(value); }
[10267]41    }
[10884]42
[11241]43    private HashSet<IArc> arcs;
[10300]44    [Storable]
[10903]45    public IEnumerable<IArc> Arcs {
46      get { return arcs; }
[11229]47      private set { arcs = new HashSet<IArc>(value); }
[10903]48    }
49
[11241]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));
[11263]59
60      // add the arcs to the newly cloned vertices
61      foreach (var arc in arcs) {
62        arc.Source.AddArc(arc);
63        arc.Target.AddArc(arc);
64      }
[11241]65    }
66
67    public override IDeepCloneable Clone(Cloner cloner) {
68      return new DirectedGraph(this, cloner);
69    }
70
[10897]71    [StorableConstructor]
72    protected DirectedGraph(bool serializing)
73      : base(serializing) {
74    }
75
[10903]76    [StorableHook(HookType.AfterDeserialization)]
77    private void AfterDeserialization() {
[11229]78      foreach (var vertex in vertices) {
[11249]79        vertex.ArcAdded += Vertex_ArcAdded;
80        vertex.ArcRemoved += Vertex_ArcRemoved;
[10903]81      }
82
[11229]83      foreach (var arc in arcs) {
84        var source = arc.Source;
85        var target = arc.Target;
86        source.AddArc(arc);
87        target.AddArc(arc);
[10903]88      }
89    }
90
[11229]91    public virtual void Clear() {
92      vertices.Clear();
93      arcs.Clear();
[10267]94    }
95
[11229]96    public virtual void AddVertex(IVertex vertex) {
[11263]97      if (!vertices.Contains(vertex) && vertex.Degree > 0)
98        throw new ArgumentException("New vertices cannot have any arcs.");
99
100      if (vertices.Add(vertex)) {
101        // register event handlers
102        vertex.ArcAdded += Vertex_ArcAdded;
103        vertex.ArcRemoved += Vertex_ArcRemoved;
104        OnVertedAdded(this, new EventArgs<IVertex>(vertex));
105      }
[10300]106    }
[10884]107
[11229]108    public virtual void RemoveVertex(IVertex vertex) {
109      vertices.Remove(vertex);
110      // remove connections to/from the removed vertex
[11238]111      var arcList = vertex.InArcs.Concat(vertex.OutArcs).ToList(); // avoid invalid operation exception: "collection was modified" below
[11234]112      foreach (var arc in arcList)
[11229]113        RemoveArc(arc);
114      // deregister event handlers
[11249]115      vertex.ArcAdded -= Vertex_ArcAdded;
116      vertex.ArcRemoved -= Vertex_ArcRemoved;
117      OnVertexRemoved(this, new EventArgs<IVertex>(vertex));
[10884]118    }
119
[11241]120    public virtual IArc AddArc(IVertex source, IVertex target) {
[11229]121      var arc = new Arc(source, target);
122      AddArc(arc);
123      return arc;
[10300]124    }
[10897]125
[11241]126    public virtual void AddArc(IArc arc) {
[11229]127      var source = (Vertex)arc.Source;
128      var target = (Vertex)arc.Target;
129      source.AddArc(arc);
130      target.AddArc(arc);
131      arcs.Add(arc);
[10267]132    }
[10897]133
[11241]134    public virtual void RemoveArc(IArc arc) {
[11229]135      arcs.Remove(arc);
136      var source = (Vertex)arc.Source;
137      var target = (Vertex)arc.Target;
138      source.RemoveArc(arc);
139      target.RemoveArc(arc);
[10267]140    }
[10897]141
[11249]142    protected virtual void Vertex_ArcAdded(object sender, EventArgs<IArc> args) {
143      // the ArcAdded event is fired by a vertex when an arc from/to another vertex is added to its list of connections
144      // because the arc is added in both directions by both the source and the target, this event will get fired twice here
[11229]145      var arc = args.Value;
[11249]146      if (arcs.Add(arc)) OnArcAdded(this, new EventArgs<IArc>(arc));
[10888]147    }
148
[11249]149    protected virtual void Vertex_ArcRemoved(object sender, EventArgs<IArc> args) {
[11229]150      var arc = args.Value;
[11249]151      if (arcs.Remove(arc)) OnArcRemoved(this, new EventArgs<IArc>(arc));
[10267]152    }
[10888]153
[11238]154    // events
[11251]155    public event EventHandler<EventArgs<IVertex>> VertexAdded;
[11249]156    protected virtual void OnVertedAdded(object sender, EventArgs<IVertex> args) {
[11248]157      var added = VertexAdded;
158      if (added != null)
159        added(sender, args);
160    }
161
[11250]162    public event EventHandler<EventArgs<IVertex>> VertexRemoved;
[11249]163    protected virtual void OnVertexRemoved(object sender, EventArgs<IVertex> args) {
[11248]164      var removed = VertexRemoved;
165      if (removed != null)
166        removed(sender, args);
167    }
168
[11250]169    public event EventHandler<EventArgs<IArc>> ArcAdded;
[11249]170    protected virtual void OnArcAdded(object sender, EventArgs<IArc> args) {
[11248]171      var added = ArcAdded;
172      if (added != null)
173        added(sender, args);
174    }
175
[11250]176    public event EventHandler<EventArgs<IArc>> ArcRemoved;
[11249]177    protected virtual void OnArcRemoved(object sender, EventArgs<IArc> args) {
[11248]178      var removed = ArcRemoved;
179      if (removed != null)
180        removed(sender, args);
181    }
[10267]182  }
183}
Note: See TracBrowser for help on using the repository browser.