Class ClusteredAdjacencyGraph<TVertex, TEdge>

Mutable clustered adjacency graph data structure.

Inheritance
System.Object
ClusteredAdjacencyGraph<TVertex, TEdge>
Implements
IVertexAndEdgeListGraph<TVertex, TEdge>
IVertexListGraph<TVertex, TEdge>
IEdgeListGraph<TVertex, TEdge>
IEdgeSet<TVertex, TEdge>
IVertexSet<TVertex>
IIncidenceGraph<TVertex, TEdge>
IImplicitGraph<TVertex, TEdge>
IGraph<TVertex, TEdge>
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 ClusteredAdjacencyGraph<TVertex, TEdge> : IVertexAndEdgeListGraph<TVertex, TEdge>, IVertexListGraph<TVertex, TEdge>, IEdgeListAndIncidenceGraph<TVertex, TEdge>, IEdgeListGraph<TVertex, TEdge>, IEdgeSet<TVertex, TEdge>, IVertexSet<TVertex>, IIncidenceGraph<TVertex, TEdge>, IImplicitGraph<TVertex, TEdge>, IGraph<TVertex, TEdge>, IImplicitVertexSet<TVertex>, IClusteredGraph where TEdge : IEdge<TVertex>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type

Constructors

| Improve this Doc View Source

ClusteredAdjacencyGraph(AdjacencyGraph<TVertex, TEdge>)

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

Declaration
public ClusteredAdjacencyGraph(AdjacencyGraph<TVertex, TEdge> wrappedGraph)
Parameters
Type Name Description
AdjacencyGraph<TVertex, TEdge> wrappedGraph

Graph to wrap.
Exceptions
Type Condition
System.ArgumentNullException

wrappedGraph is null.
| Improve this Doc View Source

ClusteredAdjacencyGraph(ClusteredAdjacencyGraph<TVertex, TEdge>)

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

Declaration
public ClusteredAdjacencyGraph(ClusteredAdjacencyGraph<TVertex, TEdge> parentGraph)
Parameters
Type Name Description
ClusteredAdjacencyGraph<TVertex, TEdge> parentGraph

Parent graph.
Exceptions
Type Condition
System.ArgumentNullException

parentGraph is null.

Properties

| Improve this Doc View Source

AllowParallelEdges

Gets a value indicating if the graph allows parallel edges

Declaration
public bool AllowParallelEdges { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Clusters

Graph clusters.

Declaration
public IEnumerable Clusters { get; }
Property Value
Type Description
System.Collections.IEnumerable
| Improve this Doc View Source

ClustersCount

Number of clusters.

Declaration
public int ClustersCount { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Collapsed

Gets or sets the collapse state of this cluster.

Declaration
public bool Collapsed { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

EdgeCapacity

Gets or sets the edge capacity.

Declaration
public int EdgeCapacity { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

EdgeCount

Gets the edge count.

Declaration
public int EdgeCount { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Edges

Gets the edges.

Declaration
public virtual IEnumerable<TEdge> Edges { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<TEdge>
| Improve this Doc View Source

EdgeType

Gets the type of edges.

Declaration
public Type EdgeType { get; }
Property Value
Type Description
System.Type
| Improve this Doc View Source

IsDirected

Gets a value indicating if the graph is directed

Declaration
public bool IsDirected { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

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
| Improve this Doc View Source

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
| Improve this Doc View Source

Parent

Parent graph.

Declaration
public ClusteredAdjacencyGraph<TVertex, TEdge> Parent { get; }
Property Value
Type Description
ClusteredAdjacencyGraph<TVertex, TEdge>
| Improve this Doc View Source

VertexCount

Gets the vertex count.

Declaration
public int VertexCount { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

VertexType

Gets the type of vertices.

Declaration
public Type VertexType { get; }
Property Value
Type Description
System.Type
| Improve this Doc View Source

Vertices

Gets the vertices.

Declaration
public virtual IEnumerable<TVertex> Vertices { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<TVertex>
| Improve this Doc View Source

Wrapped

Wrapped graph.

Declaration
protected AdjacencyGraph<TVertex, TEdge> Wrapped { get; }
Property Value
Type Description
AdjacencyGraph<TVertex, TEdge>

Methods

| Improve this Doc View Source

AddCluster()

Adds a new cluster.

Declaration
public ClusteredAdjacencyGraph<TVertex, TEdge> AddCluster()
Returns
Type Description
ClusteredAdjacencyGraph<TVertex, TEdge>

The added cluster.
| Improve this Doc View Source

AddEdge(TEdge)

Adds the edge to this graph.

Declaration
public virtual 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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

AddVertex(TVertex)

Adds a vertex to this graph.

Declaration
public virtual 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.
| Improve this Doc View Source

AddVertexRange(IEnumerable<TVertex>)

Adds given vertices to this graph.

Declaration
public virtual 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.
| Improve this Doc View Source

AddVerticesAndEdge(TEdge)

Adds edge and its vertices to this graph.

Declaration
public virtual 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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

Clear()

Clears the vertex and edges.

Declaration
public void Clear()
| Improve this Doc View Source

ClearOutEdges(TVertex)

Clears the out-edges of the given vertex

Declaration
public void ClearOutEdges(TVertex vertex)
Parameters
Type Name Description
TVertex vertex

The vertex.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

IsOutEdgesEmpty(TVertex)

Determines whether there are out-edges associated to vertex.

Declaration
public bool IsOutEdgesEmpty(TVertex vertex)
Parameters
Type Name Description
TVertex vertex

The vertex.
Returns
Type Description
System.Boolean

True if vertex has no out-edges, false otherwise.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

vertex is not part of the graph.
| Improve this Doc View Source

OutDegree(TVertex)

Gets the count of out-edges of vertex.

Declaration
public int OutDegree(TVertex vertex)
Parameters
Type Name Description
TVertex vertex

The vertex.
Returns
Type Description
System.Int32

The count of out-edges of vertex.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

vertex is not part of the graph.
| Improve this Doc View Source

OutEdge(TVertex, Int32)

Gets the out-edge of vertex at position index.

Declaration
public TEdge OutEdge(TVertex vertex, int index)
Parameters
Type Name Description
TVertex vertex

The vertex.
System.Int32 index

The index.
Returns
Type Description
TEdge

The out-edge at position index.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
System.ArgumentOutOfRangeException

No vertex at index.
VertexNotFoundException

vertex is not part of the graph.
| Improve this Doc View Source

OutEdges(TVertex)

Gets the out-edges of vertex.

Declaration
public virtual IEnumerable<TEdge> OutEdges(TVertex vertex)
Parameters
Type Name Description
TVertex vertex

The vertex.
Returns
Type Description
System.Collections.Generic.IEnumerable<TEdge>

An enumeration of the out-edges of vertex.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

vertex is not part of the graph.
| Improve this Doc View Source

RemoveCluster(IClusteredGraph)

Removes the given graph from this cluster.

Declaration
public void RemoveCluster(IClusteredGraph graph)
Parameters
Type Name Description
IClusteredGraph graph

The graph.
Exceptions
Type Condition
System.ArgumentNullException

graph is null.
| Improve this Doc View Source

RemoveEdge(TEdge)

Removes the edge from this graph.

Declaration
public virtual 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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

RemoveOutEdgeIf(TVertex, EdgePredicate<TVertex, TEdge>)

Removes all out-edges of the vertex where the predicate is evaluated to true.

Declaration
public int RemoveOutEdgeIf(TVertex vertex, EdgePredicate<TVertex, TEdge> predicate)
Parameters
Type Name Description
TVertex vertex

The vertex.
EdgePredicate<TVertex, TEdge> predicate

Predicate to remove edges.
Returns
Type Description
System.Int32

The number of removed edges.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
System.ArgumentNullException

predicate is null.
| Improve this Doc View Source

RemoveVertex(TVertex)

Removes the given vertex from this graph.

Declaration
public virtual 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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

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.
| Improve this Doc View Source

TryGetEdges(TVertex, TVertex, out IEnumerable<TEdge>)

Tries to get edges that link source and target vertices.

Declaration
public virtual bool TryGetEdges(TVertex source, TVertex target, out IEnumerable<TEdge> edges)
Parameters
Type Name Description
TVertex source

Source vertex.
TVertex target

Target vertex.
System.Collections.Generic.IEnumerable<TEdge> edges

Edges found, otherwise null.
Returns
Type Description
System.Boolean

True if at least an edge was found, false otherwise.
Exceptions
Type Condition
System.ArgumentNullException

source is null.
System.ArgumentNullException

target is null.
| Improve this Doc View Source

TryGetOutEdges(TVertex, out IEnumerable<TEdge>)

Tries to get the out-edges of vertex.

Declaration
public virtual bool TryGetOutEdges(TVertex vertex, out IEnumerable<TEdge> edges)
Parameters
Type Name Description
TVertex vertex

The vertex.
System.Collections.Generic.IEnumerable<TEdge> edges

Out-edges.
Returns
Type Description
System.Boolean

True if vertex was found or/and out-edges were found, false otherwise.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.

Explicit Interface Implementations

| Improve this Doc View Source

IClusteredGraph.AddCluster()

Adds a new cluster.

Declaration
IClusteredGraph IClusteredGraph.AddCluster()
Returns
Type Description
IClusteredGraph

The added cluster.

Implements

Extension Methods