Class UndirectedGraph<TVertex, TEdge>

Mutable undirected graph data structure.

Inheritance

System.Object

UndirectedGraph<TVertex, TEdge>

Implements

IMutableUndirectedGraph<TVertex, TEdge>

IUndirectedGraph<TVertex, TEdge>

IImplicitUndirectedGraph<TVertex, TEdge>

IMutableVertexAndEdgeSet<TVertex, TEdge>

IMutableVertexSet<TVertex>

IMutableEdgeListGraph<TVertex, TEdge>

IMutableGraph<TVertex, TEdge>

IEdgeListGraph<TVertex, TEdge>

IGraph<TVertex, TEdge>

IEdgeSet<TVertex, TEdge>

IVertexSet<TVertex>

IImplicitVertexSet<TVertex>

System.ICloneable

System.Runtime.Serialization.ISerializable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: QuikGraph

Assembly: QuikGraph.dll

Syntax

[Serializable]
public class UndirectedGraph<TVertex, TEdge> : IMutableUndirectedGraph<TVertex, TEdge>, IUndirectedGraph<TVertex, TEdge>, IImplicitUndirectedGraph<TVertex, TEdge>, IMutableVertexAndEdgeSet<TVertex, TEdge>, IMutableVertexSet<TVertex>, IMutableEdgeListGraph<TVertex, TEdge>, IMutableGraph<TVertex, TEdge>, IEdgeListGraph<TVertex, TEdge>, IGraph<TVertex, TEdge>, IEdgeSet<TVertex, TEdge>, IVertexSet<TVertex>, IImplicitVertexSet<TVertex>, ICloneable, ISerializable where TEdge : IEdge<TVertex>

Type Parameters

Name	Description
TVertex	Vertex type.
TEdge	Edge type

Constructors

UndirectedGraph()

Initializes a new instance of the UndirectedGraph<TVertex, TEdge> class.

Declaration

public UndirectedGraph()

Remarks

Allow parallel edges and gets the best edge equality comparer.

UndirectedGraph(Boolean)

Initializes a new instance of the UndirectedGraph<TVertex, TEdge> class.

Declaration

public UndirectedGraph(bool allowParallelEdges)

Parameters

Type	Name	Description
System.Boolean	allowParallelEdges	Indicates if parallel edges are allowed.

Remarks

Gets the best edge equality comparer.

UndirectedGraph(Boolean, EdgeEqualityComparer<TVertex>)

Initializes a new instance of the UndirectedGraph<TVertex, TEdge> class.

Declaration

public UndirectedGraph(bool allowParallelEdges, EdgeEqualityComparer<TVertex> edgeEqualityComparer)

Parameters

Type	Name	Description
System.Boolean	allowParallelEdges	Indicates if parallel edges are allowed.
EdgeEqualityComparer<TVertex>	edgeEqualityComparer	Equality comparer to use to compare edges.

Exceptions

Type	Condition
System.ArgumentNullException	edgeEqualityComparer is null.

UndirectedGraph(SerializationInfo, StreamingContext)

Constructor used during runtime serialization.

Declaration

protected UndirectedGraph(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
System.Runtime.Serialization.SerializationInfo	info
System.Runtime.Serialization.StreamingContext	context

Properties

AllowParallelEdges

Gets a value indicating if the graph allows parallel edges

Declaration

public bool AllowParallelEdges { get; }

Property Value

Type	Description
System.Boolean

EdgeCapacity

Gets or sets the edge capacity.

Declaration

public int EdgeCapacity { get; set; }

Property Value

Type	Description
System.Int32

EdgeCount

Gets the edge count.

Declaration

public int EdgeCount { get; }

Property Value

Type	Description
System.Int32

EdgeEqualityComparer

Comparer for edges.

Declaration

public EdgeEqualityComparer<TVertex> EdgeEqualityComparer { get; }

Property Value

Type	Description
EdgeEqualityComparer<TVertex>

Edges

Gets the edges.

Declaration

public IEnumerable<TEdge> Edges { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TEdge>

IsDirected

Gets a value indicating if the graph is directed

Declaration

public bool IsDirected { get; }

Property Value

Type	Description
System.Boolean

IsEdgesEmpty

Gets a value indicating whether there are no edges in this set. It is true if this edge set is empty, otherwise false.

Declaration

public bool IsEdgesEmpty { get; }

Property Value

Type	Description
System.Boolean

IsVerticesEmpty

Gets a value indicating whether there are no vertices in this set. It is true if this vertex set is empty, otherwise false.

Declaration

public bool IsVerticesEmpty { get; }

Property Value

Type	Description
System.Boolean

VertexCount

Gets the vertex count.

Declaration

public int VertexCount { get; }

Property Value

Type	Description
System.Int32

Vertices

Gets the vertices.

Declaration

public IEnumerable<TVertex> Vertices { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TVertex>

Methods

AddEdge(TEdge)

Adds the edge to this graph.

Declaration

public bool AddEdge(TEdge edge)

Parameters

Type	Name	Description
TEdge	edge	An edge.

Returns

Type	Description
System.Boolean	True if the edge was added, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	edge is null.

AddEdgeRange(IEnumerable<TEdge>)

Adds a set of edges to this graph.

Declaration

public int AddEdgeRange(IEnumerable<TEdge> edges)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TEdge>	edges	Edges to add.

Returns

Type	Description
System.Int32	The number of edges successfully added to this graph.

Exceptions

Type	Condition
System.ArgumentNullException	edges is null or at least one of them is null.

AddVertex(TVertex)

Adds a vertex to this set.

Declaration

public bool AddVertex(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	Vertex to add.

Returns

Type	Description
System.Boolean	True if the vertex was added, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	vertex is null.

AddVertexRange(IEnumerable<TVertex>)

Adds given vertices to this set.

Declaration

public int AddVertexRange(IEnumerable<TVertex> vertices)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TVertex>	vertices	Vertices to add.

Returns

Type	Description
System.Int32	The number of vertex added.

Exceptions

Type	Condition
System.ArgumentNullException	vertices is null or at least one of them is null.

AddVerticesAndEdge(TEdge)

Adds edge and its vertices to this graph.

Declaration

public bool AddVerticesAndEdge(TEdge edge)

Parameters

Type	Name	Description
TEdge	edge	The edge to add.

Returns

Type	Description
System.Boolean	True if the edge was added, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	edge is null.

AddVerticesAndEdgeRange(IEnumerable<TEdge>)

Adds a set of edges (and it's vertices if necessary).

Declaration

public int AddVerticesAndEdgeRange(IEnumerable<TEdge> edges)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TEdge>	edges	Edges to add.

Returns

Type	Description
System.Int32	The number of edges added.

Exceptions

Type	Condition
System.ArgumentNullException	edges is null or at least one of them is null.

AdjacentDegree(TVertex)

Gives the adjacent degree of the given vertex.

Declaration

public int AdjacentDegree(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.

Returns

Type	Description
System.Int32	Vertex adjacent degree.

Exceptions

Type	Condition
System.ArgumentNullException	vertex is null.
VertexNotFoundException	vertex is not part of the graph.

AdjacentEdge(TVertex, Int32)

Gets the indexth adjacent edge of the given vertex.

Declaration

public TEdge AdjacentEdge(TVertex vertex, int index)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.
System.Int32	index	Index of the adjacent edge requested.

Returns

Type	Description
TEdge	The adjacent edge.

Exceptions

Type	Condition
System.ArgumentNullException	vertex is null.
System.ArgumentOutOfRangeException	No vertex at index.
VertexNotFoundException	vertex is not part of the graph.

AdjacentEdges(TVertex)

Gives the enumerable of edges adjacent to the given vertex.

Declaration

public IEnumerable<TEdge> AdjacentEdges(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.

Returns

Type	Description
System.Collections.Generic.IEnumerable<TEdge>	Enumerable of adjacent edges.

Exceptions

Type	Condition
System.ArgumentNullException	vertex is null.
VertexNotFoundException	vertex is not part of the graph.

AdjacentVertices(TVertex)

Gets the set of vertices adjacent to the given vertex.

Declaration

public IEnumerable<TVertex> AdjacentVertices(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	Vertex to get adjacent ones.

Returns

Type	Description
System.Collections.Generic.IEnumerable<TVertex>	Set of adjacent vertices.

Exceptions

Type	Condition
System.ArgumentNullException	vertex is null.

Clear()

Clears the vertex and edges.

Declaration

public void Clear()

ClearAdjacentEdges(TVertex)

Clears adjacent edges of the given vertex.

Declaration

public void ClearAdjacentEdges(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.

Exceptions

Type	Condition
System.ArgumentNullException	vertex is null.

ClearEdges(TVertex)

Clears edges of the given vertex.

Declaration

public void ClearEdges(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.

Exceptions

Type	Condition
System.ArgumentNullException	vertex is null.

Clone()

Clones this graph.

Declaration

public UndirectedGraph<TVertex, TEdge> Clone()

Returns

Type	Description
UndirectedGraph<TVertex, TEdge>	Cloned graph.

ContainsEdge(TVertex, TVertex)

Checks if this graph contains an edge that link source and target vertices.

Declaration

public bool ContainsEdge(TVertex source, TVertex target)

Parameters

Type	Name	Description
TVertex	source	Source vertex.
TVertex	target	Target vertex.

Returns

Type	Description
System.Boolean	True if an edge exists, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	source is null.
System.ArgumentNullException	target is null.

ContainsEdge(TEdge)

Determines whether this set contains the specified edge.

Declaration

public bool ContainsEdge(TEdge edge)

Parameters

Type	Name	Description
TEdge	edge	Edge to check.

Returns

Type	Description
System.Boolean	True if the specified edge is contained in this set, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	edge is null.

ContainsVertex(TVertex)

Determines whether this set contains the specified vertex.

Declaration

public bool ContainsVertex(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	Vertex to check.

Returns

Type	Description
System.Boolean	True if the specified vertex is contained in this set, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	vertex is null.

GetObjectData(SerializationInfo, StreamingContext)

Gets the data to serialize.

Declaration

[SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)]
protected virtual void GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
System.Runtime.Serialization.SerializationInfo	info
System.Runtime.Serialization.StreamingContext	context

IsAdjacentEdgesEmpty(TVertex)

Indicates if the given vertex has at least one adjacent edge.

Declaration

public bool IsAdjacentEdgesEmpty(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.

Returns

Type	Description
System.Boolean	True if the vertex has at least one adjacent edge, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	vertex is null.
VertexNotFoundException	vertex is not part of the graph.

OnEdgeAdded(TEdge)

Called on each added edge.

Declaration

protected virtual void OnEdgeAdded(TEdge edge)

Parameters

Type	Name	Description
TEdge	edge	Added edge.

OnEdgeRemoved(TEdge)

Called on each removed edge.

Declaration

protected virtual void OnEdgeRemoved(TEdge edge)

Parameters

Type	Name	Description
TEdge	edge	Removed edge.

OnVertexAdded(TVertex)

Called on each added vertex.

Declaration

protected virtual void OnVertexAdded(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	Added vertex.

OnVertexRemoved(TVertex)

Called for each removed vertex.

Declaration

protected virtual void OnVertexRemoved(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	Removed vertex.

RemoveAdjacentEdgeIf(TVertex, EdgePredicate<TVertex, TEdge>)

Removes adjacent edges of the given vertex if edge matches the predicate.

Declaration

public int RemoveAdjacentEdgeIf(TVertex vertex, EdgePredicate<TVertex, TEdge> predicate)

Parameters

Type	Name	Description
TVertex	vertex	The vertex.
EdgePredicate<TVertex, TEdge>	predicate	Predicate to match edges.

Returns

Type	Description
System.Int32	The number of removed edges.

Exceptions

Type	Condition
System.ArgumentNullException	vertex is null.
System.ArgumentNullException	predicate is null.

RemoveEdge(TEdge)

Removes the edge from this graph.

Declaration

public bool RemoveEdge(TEdge edge)

Parameters

Type	Name	Description
TEdge	edge	Edge to remove.

Returns

Type	Description
System.Boolean	True if the edge was successfully removed, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	edge is null.

RemoveEdgeIf(EdgePredicate<TVertex, TEdge>)

Removes all edges that match the given predicate.

Declaration

public int RemoveEdgeIf(EdgePredicate<TVertex, TEdge> predicate)

Parameters

Type	Name	Description
EdgePredicate<TVertex, TEdge>	predicate	Predicate to check if an edge should be removed.

Returns

Type	Description
System.Int32	The number of edges removed.

Exceptions

Type	Condition
System.ArgumentNullException	predicate is null.

RemoveEdges(IEnumerable<TEdge>)

Removes the given set of edges.

Declaration

public int RemoveEdges(IEnumerable<TEdge> edges)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<TEdge>	edges	Edges to remove.

Returns

Type	Description
System.Int32	The number of removed edges.

Exceptions

Type	Condition
System.ArgumentNullException	edges is null or at least one of them is null.

RemoveVertex(TVertex)

Removes the given vertex from this set.

Declaration

public bool RemoveVertex(TVertex vertex)

Parameters

Type	Name	Description
TVertex	vertex	Vertex to remove.

Returns

Type	Description
System.Boolean	True if the vertex was removed, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	vertex is null.

RemoveVertexIf(VertexPredicate<TVertex>)

Removes all vertices matching the given predicate.

Declaration

public int RemoveVertexIf(VertexPredicate<TVertex> predicate)

Parameters

Type	Name	Description
VertexPredicate<TVertex>	predicate	Predicate to check on each vertex.

Returns

Type	Description
System.Int32	The number of vertex removed.

Exceptions

Type	Condition
System.ArgumentNullException	predicate is null.

TrimEdgeExcess()

Trims excess storage allocated for edges.

Declaration

public void TrimEdgeExcess()

TryGetEdge(TVertex, TVertex, out TEdge)

Tries to get the edge that link source and target vertices.

Declaration

public bool TryGetEdge(TVertex source, TVertex target, out TEdge edge)

Parameters

Type	Name	Description
TVertex	source	Source vertex.
TVertex	target	Target vertex.
TEdge	edge	Edge found, otherwise null.

Returns

Type	Description
System.Boolean	True if an edge was found, false otherwise.

Exceptions

Type	Condition
System.ArgumentNullException	source is null.
System.ArgumentNullException	target is null.

Events

EdgeAdded

Fired when an edge is added to this graph.

Declaration

public event EdgeAction<TVertex, TEdge> EdgeAdded

Event Type

Type	Description
EdgeAction<TVertex, TEdge>

EdgeRemoved

Fired when an edge has been removed from this graph.

Declaration

public event EdgeAction<TVertex, TEdge> EdgeRemoved

Event Type

Type	Description
EdgeAction<TVertex, TEdge>

VertexAdded

Fired when a vertex is added to this set.

Declaration

public event VertexAction<TVertex> VertexAdded

Event Type

Type	Description
VertexAction<TVertex>

VertexRemoved

Fired when a vertex is removed from this set.

Declaration

public event VertexAction<TVertex> VertexRemoved

Event Type

Type	Description
VertexAction<TVertex>

Explicit Interface Implementations

ICloneable.Clone()

Declaration

object ICloneable.Clone()

Returns

Type	Description
System.Object

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Declaration

[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
System.Runtime.Serialization.SerializationInfo	info
System.Runtime.Serialization.StreamingContext	context

Implements

IMutableUndirectedGraph<TVertex, TEdge>

IUndirectedGraph<TVertex, TEdge>

IImplicitUndirectedGraph<TVertex, TEdge>

IMutableVertexAndEdgeSet<TVertex, TEdge>

IMutableVertexSet<TVertex>

IMutableEdgeListGraph<TVertex, TEdge>

IMutableGraph<TVertex, TEdge>

IEdgeListGraph<TVertex, TEdge>

IGraph<TVertex, TEdge>

IEdgeSet<TVertex, TEdge>

IVertexSet<TVertex>

IImplicitVertexSet<TVertex>

System.ICloneable

System.Runtime.Serialization.ISerializable

Extension Methods

GraphMLExtensions.SerializeToGraphML<TVertex, TEdge, TGraph>(TGraph, String)

GraphMLExtensions.SerializeToGraphML<TVertex, TEdge, TGraph>(TGraph, String, VertexIdentity<TVertex>, EdgeIdentity<TVertex, TEdge>)

GraphMLExtensions.SerializeToGraphML<TVertex, TEdge, TGraph>(TGraph, XmlWriter)

GraphMLExtensions.SerializeToGraphML<TVertex, TEdge, TGraph>(TGraph, XmlWriter, VertexIdentity<TVertex>, EdgeIdentity<TVertex, TEdge>)

GraphMLExtensions.DeserializeFromGraphML<TVertex, TEdge, TGraph>(TGraph, XmlReader, IdentifiableVertexFactory<TVertex>, IdentifiableEdgeFactory<TVertex, TEdge>)

GraphMLExtensions.DeserializeFromGraphML<TVertex, TEdge, TGraph>(TGraph, TextReader, IdentifiableVertexFactory<TVertex>, IdentifiableEdgeFactory<TVertex, TEdge>)

GraphMLExtensions.DeserializeFromGraphML<TVertex, TEdge, TGraph>(TGraph, String, IdentifiableVertexFactory<TVertex>, IdentifiableEdgeFactory<TVertex, TEdge>)

GraphMLExtensions.DeserializeAndValidateFromGraphML<TVertex, TEdge, TGraph>(TGraph, TextReader, IdentifiableVertexFactory<TVertex>, IdentifiableEdgeFactory<TVertex, TEdge>)

SerializationExtensions.SerializeToBinary<TVertex, TEdge>(IGraph<TVertex, TEdge>, Stream)

SerializationExtensions.SerializeToXml<TVertex, TEdge, TGraph>(TGraph, XmlWriter, VertexIdentity<TVertex>, EdgeIdentity<TVertex, TEdge>, String, String, String, String)

SerializationExtensions.SerializeToXml<TVertex, TEdge, TGraph>(TGraph, XmlWriter, VertexIdentity<TVertex>, EdgeIdentity<TVertex, TEdge>, String, String, String, String, Action<XmlWriter, TGraph>, Action<XmlWriter, TVertex>, Action<XmlWriter, TEdge>)

GraphExtensions.ToBidirectionalGraph<TVertex, TEdge>(IUndirectedGraph<TVertex, TEdge>)

GraphExtensions.ToArrayUndirectedGraph<TVertex, TEdge>(IUndirectedGraph<TVertex, TEdge>)

AlgorithmExtensions.GetVertexIdentity<TVertex>(IVertexSet<TVertex>)

AlgorithmExtensions.GetEdgeIdentity<TVertex, TEdge>(IEdgeSet<TVertex, TEdge>)

AlgorithmExtensions.ShortestPathsDijkstra<TVertex, TEdge>(IUndirectedGraph<TVertex, TEdge>, Func<TEdge, Double>, TVertex)

AlgorithmExtensions.TopologicalSort<TVertex, TEdge>(IUndirectedGraph<TVertex, TEdge>)

AlgorithmExtensions.SourceFirstTopologicalSort<TVertex, TEdge>(IUndirectedGraph<TVertex, TEdge>)

AlgorithmExtensions.ConnectedComponents<TVertex, TEdge>(IUndirectedGraph<TVertex, TEdge>, IDictionary<TVertex, Int32>)

AlgorithmExtensions.IncrementalConnectedComponents<TVertex, TEdge>(IMutableVertexAndEdgeSet<TVertex, TEdge>, out Func<KeyValuePair<Int32, IDictionary<TVertex, Int32>>>)

AlgorithmExtensions.IsUndirectedAcyclicGraph<TVertex, TEdge>(IUndirectedGraph<TVertex, TEdge>)

AlgorithmExtensions.ComputeDisjointSet<TVertex, TEdge>(IUndirectedGraph<TVertex, TEdge>)

AlgorithmExtensions.MinimumSpanningTreePrim<TVertex, TEdge>(IUndirectedGraph<TVertex, TEdge>, Func<TEdge, Double>)

AlgorithmExtensions.MinimumSpanningTreeKruskal<TVertex, TEdge>(IUndirectedGraph<TVertex, TEdge>, Func<TEdge, Double>)

AlgorithmExtensions.ComputeTransitiveReduction<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>)

AlgorithmExtensions.ComputeTransitiveClosure<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, Func<TVertex, TVertex, TEdge>)

GraphvizExtensions.ToGraphviz<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>)

GraphvizExtensions.ToGraphviz<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, Action<GraphvizAlgorithm<TVertex, TEdge>>)

GraphvizExtensions.ToSvg<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>)

GraphvizExtensions.ToSvg<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, Action<GraphvizAlgorithm<TVertex, TEdge>>)

MsaglGraphExtensions.CreateMsaglPopulator<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>)

MsaglGraphExtensions.CreateMsaglPopulator<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, String, IFormatProvider)

MsaglGraphExtensions.CreateMsaglPopulator<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, VertexIdentity<TVertex>)

MsaglGraphExtensions.ToMsaglGraph<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, MsaglVertexNodeEventHandler<TVertex>, MsaglEdgeEventHandler<TVertex, TEdge>)

MsaglGraphExtensions.ToMsaglGraph<TVertex, TEdge>(IEdgeListGraph<TVertex, TEdge>, VertexIdentity<TVertex>, MsaglVertexNodeEventHandler<TVertex>, MsaglEdgeEventHandler<TVertex, TEdge>)