[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 |
|
---|
| 22 | using System;
|
---|
| 23 | using System.Collections.Generic;
|
---|
| 24 | using System.Drawing;
|
---|
| 25 | using System.Linq;
|
---|
| 26 | using HeuristicLab.Common;
|
---|
[11241] | 27 | using HeuristicLab.Common.Resources;
|
---|
[10267] | 28 | using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
|
---|
| 29 |
|
---|
[11241] | 30 | namespace 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 |
|
---|
[11324] | 108 | public virtual void AddVertices(IEnumerable<IVertex> vertexList) {
|
---|
| 109 | var hash = new HashSet<IVertex>(vertexList);
|
---|
| 110 | var arcList = vertexList.SelectMany(v => v.InArcs.Concat(v.OutArcs));
|
---|
| 111 | if (arcList.Any(x => !hash.Contains(x.Source) || !hash.Contains(x.Target)))
|
---|
| 112 | throw new ArgumentException("Vertex arcs are connected to vertices not in the graph.");
|
---|
| 113 | // if everything is in order, add the vertices to the directed graph
|
---|
| 114 | foreach (var v in vertexList)
|
---|
| 115 | vertices.Add(v);
|
---|
| 116 | foreach (var a in arcList)
|
---|
| 117 | arcs.Add(a);
|
---|
| 118 | }
|
---|
| 119 |
|
---|
[11391] | 120 | public virtual void RemoveVertices(IEnumerable<IVertex> vertexList) {
|
---|
| 121 | foreach (var v in vertexList)
|
---|
| 122 | RemoveVertex(v);
|
---|
| 123 | }
|
---|
| 124 |
|
---|
[11229] | 125 | public virtual void RemoveVertex(IVertex vertex) {
|
---|
| 126 | vertices.Remove(vertex);
|
---|
| 127 | // remove connections to/from the removed vertex
|
---|
[11238] | 128 | var arcList = vertex.InArcs.Concat(vertex.OutArcs).ToList(); // avoid invalid operation exception: "collection was modified" below
|
---|
[11234] | 129 | foreach (var arc in arcList)
|
---|
[11229] | 130 | RemoveArc(arc);
|
---|
| 131 | // deregister event handlers
|
---|
[11249] | 132 | vertex.ArcAdded -= Vertex_ArcAdded;
|
---|
| 133 | vertex.ArcRemoved -= Vertex_ArcRemoved;
|
---|
| 134 | OnVertexRemoved(this, new EventArgs<IVertex>(vertex));
|
---|
[10884] | 135 | }
|
---|
| 136 |
|
---|
[11241] | 137 | public virtual IArc AddArc(IVertex source, IVertex target) {
|
---|
[11229] | 138 | var arc = new Arc(source, target);
|
---|
| 139 | AddArc(arc);
|
---|
| 140 | return arc;
|
---|
[10300] | 141 | }
|
---|
[10897] | 142 |
|
---|
[11241] | 143 | public virtual void AddArc(IArc arc) {
|
---|
[11324] | 144 | var source = arc.Source;
|
---|
| 145 | var target = arc.Target;
|
---|
| 146 |
|
---|
[11444] | 147 | if (source == target)
|
---|
| 148 | throw new InvalidOperationException("Source and target cannot be the same.");
|
---|
| 149 |
|
---|
[11324] | 150 | if (!vertices.Contains(source) || !vertices.Contains(target))
|
---|
| 151 | throw new InvalidOperationException("Cannot add arc connecting vertices that are not in the graph.");
|
---|
| 152 |
|
---|
[11229] | 153 | source.AddArc(arc);
|
---|
| 154 | target.AddArc(arc);
|
---|
| 155 | arcs.Add(arc);
|
---|
[10267] | 156 | }
|
---|
[10897] | 157 |
|
---|
[11241] | 158 | public virtual void RemoveArc(IArc arc) {
|
---|
[11229] | 159 | arcs.Remove(arc);
|
---|
| 160 | var source = (Vertex)arc.Source;
|
---|
| 161 | var target = (Vertex)arc.Target;
|
---|
| 162 | source.RemoveArc(arc);
|
---|
| 163 | target.RemoveArc(arc);
|
---|
[10267] | 164 | }
|
---|
[10897] | 165 |
|
---|
[11249] | 166 | protected virtual void Vertex_ArcAdded(object sender, EventArgs<IArc> args) {
|
---|
| 167 | // the ArcAdded event is fired by a vertex when an arc from/to another vertex is added to its list of connections
|
---|
| 168 | // because the arc is added in both directions by both the source and the target, this event will get fired twice here
|
---|
[11229] | 169 | var arc = args.Value;
|
---|
[11249] | 170 | if (arcs.Add(arc)) OnArcAdded(this, new EventArgs<IArc>(arc));
|
---|
[10888] | 171 | }
|
---|
| 172 |
|
---|
[11249] | 173 | protected virtual void Vertex_ArcRemoved(object sender, EventArgs<IArc> args) {
|
---|
[11229] | 174 | var arc = args.Value;
|
---|
[11249] | 175 | if (arcs.Remove(arc)) OnArcRemoved(this, new EventArgs<IArc>(arc));
|
---|
[10267] | 176 | }
|
---|
[10888] | 177 |
|
---|
[11238] | 178 | // events
|
---|
[11251] | 179 | public event EventHandler<EventArgs<IVertex>> VertexAdded;
|
---|
[11249] | 180 | protected virtual void OnVertedAdded(object sender, EventArgs<IVertex> args) {
|
---|
[11248] | 181 | var added = VertexAdded;
|
---|
| 182 | if (added != null)
|
---|
| 183 | added(sender, args);
|
---|
| 184 | }
|
---|
| 185 |
|
---|
[11250] | 186 | public event EventHandler<EventArgs<IVertex>> VertexRemoved;
|
---|
[11249] | 187 | protected virtual void OnVertexRemoved(object sender, EventArgs<IVertex> args) {
|
---|
[11248] | 188 | var removed = VertexRemoved;
|
---|
| 189 | if (removed != null)
|
---|
| 190 | removed(sender, args);
|
---|
| 191 | }
|
---|
| 192 |
|
---|
[11250] | 193 | public event EventHandler<EventArgs<IArc>> ArcAdded;
|
---|
[11249] | 194 | protected virtual void OnArcAdded(object sender, EventArgs<IArc> args) {
|
---|
[11248] | 195 | var added = ArcAdded;
|
---|
| 196 | if (added != null)
|
---|
| 197 | added(sender, args);
|
---|
| 198 | }
|
---|
| 199 |
|
---|
[11250] | 200 | public event EventHandler<EventArgs<IArc>> ArcRemoved;
|
---|
[11249] | 201 | protected virtual void OnArcRemoved(object sender, EventArgs<IArc> args) {
|
---|
[11248] | 202 | var removed = ArcRemoved;
|
---|
| 203 | if (removed != null)
|
---|
| 204 | removed(sender, args);
|
---|
| 205 | }
|
---|
[10267] | 206 | }
|
---|
| 207 | }
|
---|