Interface ITermBidirectionalGraph<TVertex, TEdge>

A directed graph with vertices of type TVertex and terminal edges of type TEdge, that is efficient to traverse both in and out edges.

Inherited Members
Namespace: QuikGraph
Assembly: QuikGraph.dll
Syntax
public interface ITermBidirectionalGraph<TVertex, TEdge> : IBidirectionalGraph<TVertex, TEdge>, IVertexAndEdgeListGraph<TVertex, TEdge>, IVertexListGraph<TVertex, TEdge>, IEdgeListGraph<TVertex, TEdge>, IEdgeSet<TVertex, TEdge>, IVertexSet<TVertex>, IBidirectionalIncidenceGraph<TVertex, TEdge>, IIncidenceGraph<TVertex, TEdge>, IImplicitGraph<TVertex, TEdge>, IGraph<TVertex, TEdge>, IImplicitVertexSet<TVertex> where TEdge : ITermEdge<TVertex>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.

Methods

| Improve this Doc View Source

InDegreeAt(TVertex, Int32)

Gets the vertex in-degree for the requested terminal.

Declaration
int InDegreeAt(TVertex vertex, int terminal)
Parameters
Type Name Description
TVertex vertex

The vertex.
System.Int32 terminal

In terminal index.
Returns
Type Description
System.Int32

The vertex in-degree on terminal terminal.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

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

InEdgesAt(TVertex, Int32)

Gets the vertex in-edges for the requested terminal.

Declaration
IEnumerable<TEdge> InEdgesAt(TVertex vertex, int terminal)
Parameters
Type Name Description
TVertex vertex

The vertex.
System.Int32 terminal

In terminal index.
Returns
Type Description
System.Collections.Generic.IEnumerable<TEdge>

The vertex in-edges on terminal terminal.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

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

InTerminalCount(TVertex)

Gets the number of in terminals on the given vertex.

Declaration
int InTerminalCount(TVertex vertex)
Parameters
Type Name Description
TVertex vertex

The vertex.
Returns
Type Description
System.Int32

Number of in terminals.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

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

IsInEdgesEmptyAt(TVertex, Int32)

Checks if the requested in terminal is empty or not for the given vertex.

Declaration
bool IsInEdgesEmptyAt(TVertex vertex, int terminal)
Parameters
Type Name Description
TVertex vertex

The vertex.
System.Int32 terminal

In terminal index.
Returns
Type Description
System.Boolean

True if the in terminal is empty, false otherwise.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

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

IsOutEdgesEmptyAt(TVertex, Int32)

Checks if the requested out terminal is empty or not for the given vertex.

Declaration
bool IsOutEdgesEmptyAt(TVertex vertex, int terminal)
Parameters
Type Name Description
TVertex vertex

The vertex.
System.Int32 terminal

Out terminal index.
Returns
Type Description
System.Boolean

True if the out terminal is empty, false otherwise.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

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

OutDegreeAt(TVertex, Int32)

Gets the vertex out-degree for the requested terminal.

Declaration
int OutDegreeAt(TVertex vertex, int terminal)
Parameters
Type Name Description
TVertex vertex

The vertex.
System.Int32 terminal

Out terminal index.
Returns
Type Description
System.Int32

The vertex out-degree on terminal terminal.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

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

OutEdgesAt(TVertex, Int32)

Gets the vertex out edges for the requested terminal.

Declaration
IEnumerable<TEdge> OutEdgesAt(TVertex vertex, int terminal)
Parameters
Type Name Description
TVertex vertex

The vertex.
System.Int32 terminal

Out terminal index.
Returns
Type Description
System.Collections.Generic.IEnumerable<TEdge>

The vertex out-edges on terminal terminal.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

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

OutTerminalCount(TVertex)

Gets the number of out terminals on the given vertex.

Declaration
int OutTerminalCount(TVertex vertex)
Parameters
Type Name Description
TVertex vertex

The vertex.
Returns
Type Description
System.Int32

Number of out terminals.
Exceptions
Type Condition
System.ArgumentNullException

vertex is null.
VertexNotFoundException

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

TryGetInEdgesAt(TVertex, Int32, out IEnumerable<TEdge>)

Tries to get the vertex in-edges for the requested terminal.

Declaration
bool TryGetInEdgesAt(TVertex vertex, int terminal, out IEnumerable<TEdge> edges)
Parameters
Type Name Description
TVertex vertex

The vertex.
System.Int32 terminal

Out terminal index.
System.Collections.Generic.IEnumerable<TEdge> edges

In-edges found, otherwise null.
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

TryGetOutEdgesAt(TVertex, Int32, out IEnumerable<TEdge>)

Tries to get the vertex out-edges for the requested terminal.

Declaration
bool TryGetOutEdgesAt(TVertex vertex, int terminal, out IEnumerable<TEdge> edges)
Parameters
Type Name Description
TVertex vertex

The vertex.
System.Int32 terminal

Out terminal index.
System.Collections.Generic.IEnumerable<TEdge> edges

Out-edges found, otherwise null.
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.

Extension Methods