Class BidirectionalMatrixGraph<TEdge>

Mutable bidirectional graph data structure based on a matrix.

Inheritance
System.Object
BidirectionalMatrixGraph<TEdge>
Implements
IBidirectionalGraph<System.Int32, TEdge>
IVertexAndEdgeListGraph<System.Int32, TEdge>
IVertexListGraph<System.Int32, TEdge>
IBidirectionalIncidenceGraph<System.Int32, TEdge>
IIncidenceGraph<System.Int32, TEdge>
IImplicitGraph<System.Int32, TEdge>
IMutableEdgeListGraph<System.Int32, TEdge>
IMutableGraph<System.Int32, TEdge>
IEdgeListGraph<System.Int32, TEdge>
IGraph<System.Int32, TEdge>
IEdgeSet<System.Int32, TEdge>
IVertexSet<System.Int32>
IImplicitVertexSet<System.Int32>
System.ICloneable
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 BidirectionalMatrixGraph<TEdge> : IBidirectionalGraph<int, TEdge>, IVertexAndEdgeListGraph<int, TEdge>, IVertexListGraph<int, TEdge>, IBidirectionalIncidenceGraph<int, TEdge>, IIncidenceGraph<int, TEdge>, IImplicitGraph<int, TEdge>, IMutableEdgeListGraph<int, TEdge>, IMutableGraph<int, TEdge>, IEdgeListGraph<int, TEdge>, IGraph<int, TEdge>, IEdgeSet<int, TEdge>, IVertexSet<int>, IImplicitVertexSet<int>, ICloneable where TEdge : class, IEdge<int>
Type Parameters
Name Description
TEdge

Edge type

Constructors

| Improve this Doc View Source

BidirectionalMatrixGraph(Int32)

Initializes a new instance of the BidirectionalMatrixGraph<TEdge> class.

Declaration
public BidirectionalMatrixGraph(int vertexCount)
Parameters
Type Name Description
System.Int32 vertexCount

Number of vertices.
Exceptions
Type Condition
System.ArgumentException

vertexCount is is negative or equal to 0.

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

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 IEnumerable<TEdge> Edges { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<TEdge>
| 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

VertexCount

Gets the vertex count.

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

Vertices

Gets the vertices.

Declaration
public IEnumerable<int> Vertices { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.Int32>

Methods

| Improve this Doc View Source

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
ParallelEdgeNotAllowedException

edge is already present in graph.
| 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

Clear()

Clears the vertex and edges.

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

ClearEdges(Int32)

Clears the in-edges and out-edges of the given vertex.

Declaration
public void ClearEdges(int vertex)
Parameters
Type Name Description
System.Int32 vertex

The vertex.
| Improve this Doc View Source

ClearInEdges(Int32)

Clears the in-edges of the given vertex.

Declaration
public void ClearInEdges(int vertex)
Parameters
Type Name Description
System.Int32 vertex

The vertex.
| Improve this Doc View Source

ClearOutEdges(Int32)

Clears the out-edges of the given vertex

Declaration
public void ClearOutEdges(int vertex)
Parameters
Type Name Description
System.Int32 vertex

The vertex.
| Improve this Doc View Source

Clone()

Clones this graph.

Declaration
public BidirectionalMatrixGraph<TEdge> Clone()
Returns
Type Description
BidirectionalMatrixGraph<TEdge>

Cloned graph.
| 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

ContainsEdge(Int32, Int32)

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

Declaration
public bool ContainsEdge(int source, int target)
Parameters
Type Name Description
System.Int32 source
System.Int32 target
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

ContainsVertex(Int32)

Determines whether this set contains the specified vertex.

Declaration
public bool ContainsVertex(int vertex)
Parameters
Type Name Description
System.Int32 vertex
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

Degree(Int32)

Gets the degree of vertex, i.e. the sum of the out-degree and in-degree of vertex.

Declaration
public int Degree(int vertex)
Parameters
Type Name Description
System.Int32 vertex
Returns
Type Description
System.Int32

The sum of OutDegree and InDegree of vertex.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

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

InDegree(Int32)

Gets the number of in-edges of vertex.

Declaration
public int InDegree(int vertex)
Parameters
Type Name Description
System.Int32 vertex
Returns
Type Description
System.Int32

The number of in-edges pointing towards vertex.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

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

InEdge(Int32, Int32)

Gets the in-edge at location index.

Declaration
public TEdge InEdge(int vertex, int index)
Parameters
Type Name Description
System.Int32 vertex
System.Int32 index

The index.
Returns
Type Description
TEdge

The in-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

InEdges(Int32)

Gets the collection of in-edges of vertex.

Declaration
public IEnumerable<TEdge> InEdges(int vertex)
Parameters
Type Name Description
System.Int32 vertex
Returns
Type Description
System.Collections.Generic.IEnumerable<TEdge>

The collection of in-edges of vertex.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

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

IsInEdgesEmpty(Int32)

Determines whether vertex has no in-edges.

Declaration
public bool IsInEdgesEmpty(int vertex)
Parameters
Type Name Description
System.Int32 vertex
Returns
Type Description
System.Boolean

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

vertex is null.
VertexNotFoundException

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

IsOutEdgesEmpty(Int32)

Determines whether there are out-edges associated to vertex.

Declaration
public bool IsOutEdgesEmpty(int vertex)
Parameters
Type Name Description
System.Int32 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

OnEdgeAdded(TEdge)

Called on each added edge.

Declaration
protected virtual void OnEdgeAdded(TEdge edge)
Parameters
Type Name Description
TEdge edge

Added edge.
| Improve this Doc View Source

OnEdgeRemoved(TEdge)

Called on each removed edge.

Declaration
protected virtual void OnEdgeRemoved(TEdge edge)
Parameters
Type Name Description
TEdge edge

Removed edge.
| Improve this Doc View Source

OutDegree(Int32)

Gets the count of out-edges of vertex.

Declaration
public int OutDegree(int vertex)
Parameters
Type Name Description
System.Int32 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(Int32, Int32)

Gets the out-edge of vertex at position index.

Declaration
public TEdge OutEdge(int vertex, int index)
Parameters
Type Name Description
System.Int32 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(Int32)

Gets the out-edges of vertex.

Declaration
public IEnumerable<TEdge> OutEdges(int vertex)
Parameters
Type Name Description
System.Int32 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

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

RemoveEdgeIf(EdgePredicate<Int32, TEdge>)

RemoveEdgeIf(EdgePredicate<Int32, TEdge>) is not implemented for this kind of graph.

Declaration
public int RemoveEdgeIf(EdgePredicate<int, TEdge> predicate)
Parameters
Type Name Description
EdgePredicate<System.Int32, TEdge> predicate
Returns
Type Description
System.Int32
Exceptions
Type Condition
System.NotSupportedException

This method is not supported.
| Improve this Doc View Source

RemoveInEdgeIf(Int32, EdgePredicate<Int32, TEdge>)

Removes in-edges of the given vertex that match predicate predicate.

Declaration
public int RemoveInEdgeIf(int vertex, EdgePredicate<int, TEdge> predicate)
Parameters
Type Name Description
System.Int32 vertex

The vertex.
EdgePredicate<System.Int32, TEdge> predicate

Edge predicate.
Returns
Type Description
System.Int32

Number of edges removed.
Exceptions
Type Condition
System.ArgumentNullException

predicate is null.
| Improve this Doc View Source

RemoveOutEdgeIf(Int32, EdgePredicate<Int32, TEdge>)

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

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

The vertex.
EdgePredicate<System.Int32, TEdge> predicate

Predicate to remove edges.
Returns
Type Description
System.Int32

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

predicate is null.
| Improve this Doc View Source

TryGetEdge(Int32, Int32, out TEdge)

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

Declaration
public bool TryGetEdge(int source, int target, out TEdge edge)
Parameters
Type Name Description
System.Int32 source
System.Int32 target
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(Int32, Int32, out IEnumerable<TEdge>)

Tries to get edges that link source and target vertices.

Declaration
public bool TryGetEdges(int source, int target, out IEnumerable<TEdge> edges)
Parameters
Type Name Description
System.Int32 source
System.Int32 target
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

TryGetInEdges(Int32, out IEnumerable<TEdge>)

Tries to get the in-edges of vertex.

Declaration
public bool TryGetInEdges(int vertex, out IEnumerable<TEdge> edges)
Parameters
Type Name Description
System.Int32 vertex
System.Collections.Generic.IEnumerable<TEdge> edges

In-edges.
Returns
Type Description
System.Boolean

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

vertex is null.
| Improve this Doc View Source

TryGetOutEdges(Int32, out IEnumerable<TEdge>)

Tries to get the out-edges of vertex.

Declaration
public bool TryGetOutEdges(int vertex, out IEnumerable<TEdge> edges)
Parameters
Type Name Description
System.Int32 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.

Events

| Improve this Doc View Source

EdgeAdded

Fired when an edge is added to this graph.

Declaration
public event EdgeAction<int, TEdge> EdgeAdded
Event Type
Type Description
EdgeAction<System.Int32, TEdge>
| Improve this Doc View Source

EdgeRemoved

Fired when an edge has been removed from this graph.

Declaration
public event EdgeAction<int, TEdge> EdgeRemoved
Event Type
Type Description
EdgeAction<System.Int32, TEdge>

Explicit Interface Implementations

| Improve this Doc View Source

ICloneable.Clone()

Declaration
object ICloneable.Clone()
Returns
Type Description
System.Object

Implements

System.ICloneable

Extension Methods