Interface IMutableEdgeListGraph<TVertex, TEdge>

A mutable edge list graph with vertices of type TVertex and edges of type TEdge.

Inherited Members
Namespace: QuikGraph
Assembly: QuikGraph.dll
Syntax
public interface IMutableEdgeListGraph<TVertex, TEdge> : IMutableGraph<TVertex, TEdge>, IEdgeListGraph<TVertex, TEdge>, IGraph<TVertex, TEdge>, IEdgeSet<TVertex, TEdge>, IVertexSet<TVertex>, IImplicitVertexSet<TVertex> where TEdge : IEdge<TVertex>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.

Methods

| Improve this Doc View Source

AddEdge(TEdge)

Adds the edge to this graph.

Declaration
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
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

RemoveEdge(TEdge)

Removes the edge from this graph.

Declaration
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
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.

Events

| Improve this Doc View Source

EdgeAdded

Fired when an edge is added to this graph.

Declaration
event EdgeAction<TVertex, TEdge> EdgeAdded
Event Type
Type Description
EdgeAction<TVertex, TEdge>
| Improve this Doc View Source

EdgeRemoved

Fired when an edge has been removed from this graph.

Declaration
event EdgeAction<TVertex, TEdge> EdgeRemoved
Event Type
Type Description
EdgeAction<TVertex, TEdge>

Extension Methods