Class EdgeStump
Encapsulate information for a single edge.

Defined in <seqan/graph_types.h>
Signature template <typename TCargo, bool IS_LIST, bool STORE_SOURCE, bool STORE_ID, typename TSpec> class EdgeStump;

Template Parameters

TCargo The cargo type of an edge. The cargo can be used to store arbitrary information with an edge or be void. Default: void.
IS_LIST A bool value that indicates whether it is a list or not. Default: true.
STORE_SOURCE A bool value that indicates whether the source is stored in the EdgeStump or not. Default: false.
STORE_ID A bool value that indictes whether the id is tored in the EdgeStump or not. Note: Without edge ids, external property maps do not work for edges! Default: true.
TSpec The specializing type. Default: Default.

Interface Function Overview

Detailed Description

The EdgeStump either represents a list entry in the adjacency of a graph or an array field if edges are stored in an array.

Remarks

The default EdgeStump in all graph types does not consider a cargo. However, ni default usage every graph does store an edge id. Edge ids are used to append additional properties to edges with the help of external property maps.

Interface Functions Detail

void assignCargo(stump, cargo);

Assigns a new cargo to the edge.

Parameters

stump Pointer to the EdgeStump to set the cargo of.

Returns

TCargo Reference to the cargo of the EdgeStump.

Calling assignCargo on EdgeStump objects without cargo does nothing.

Data Races

Thread safety unknown!

void assignNextS(es, es2);

Assigns another EdgeStump to the next source pointer.

Parameters

es Pointer to the EdgeStump.
es2 Pointer to the following EdgeStump.

Edge Stumps can be configured to have no source. In this case, there is no next source pointer.

Data Races

Thread safety unknown!

void assignNextT(es, es2);

Assigns another EdgeStump to the next target pointer.

Parameters

es Pointer to the EdgeStump.
es2 Pointer to the following EdgeStump.

Data Races

Thread safety unknown!

void assignSource(stump, t);

Assigns a source vertex to an edge.

Parameters

stump Pointer to the EdgeStump.
t Vertex descriptor to assign as the source.

Remarks

A source vertex is not required in an edge stump. However, EdgeStump objects can be configured to contain a source vertex, as in undirected graphs.

Data Races

Thread safety unknown!

void assignTarget(stump, t);

Assigns a target vertex to an edge.

Parameters

stump Pointer to the EdgeStump.
t Vertex descriptor to assign as the target.

Data Races

Thread safety unknown!

TCargo cargo(stump);

Return cargo for an EdgeStump.

Parameters

stump Pointer to the EdgeStump to query for its cargo.

Returns

TCargo Reference to the cargo of the EdgeStump.

Data Races

Thread safety unknown!

TCargo getCargo(stump);

Return cargo for an EdgeStump.

Parameters

stump Pointer to the EdgeStump to query for its cargo.

Returns

TCargo Reference to the cargo of the EdgeStump.

Data Races

Thread safety unknown!

TEdgeStump getNextS(es);

Accesses the next source pointer.

Parameters

es Pointer to the EdgeStump.

Returns

Reference to the next source pointer.

Edge Stumps can be configured to have no source. In this case, there is no next source pointer.

Data Races

Thread safety unknown!

TEdgeStump getNextT(es);

Get method for the next target pointer.

Parameters

es Pointer to the EdgeStump.

Returns

TEdgeStump Reference to the next target pointer.

Data Races

Thread safety unknown!

TVertexDescriptor getSource(stump);

Get method for the source.

Parameters

stump Pointer to the EdgeStump to get the source of.

Returns

TVertexDescriptor The vetex descriptor stored in stump.

Remarks

A source vertex is not required in an edge stump. However, EdgeStump objects can be configured to contain a source vertex, as in undirected graphs.

Data Races

Thread safety unknown!

TVertexDescriptor getTarget(stump);

Get method for the target.

Parameters

stump Pointer to the EdgeStump to get the target of.

Returns

TVertexDescriptor The vetex descriptor stored in stump.

Data Races

Thread safety unknown!

TEdgeStump nextS(es);

Accesses the next source pointer.

Parameters

es Pointer to the EdgeStump.

Returns

Reference to the next source pointer.

Edge Stumps can be configured to have no source. In this case, there is no next source pointer.

Data Races

Thread safety unknown!

TEdgeStump nextT(es);

Accesses the next target pointer.

Parameters

es Pointer to the EdgeStump.

Returns

TEdgeStump Reference to the next target pointer.

Data Races

Thread safety unknown!

TVertexDescriptor source(stump);

Access to the source of an EdgeStump.

Parameters

stump Pointer to the EdgeStump to access the source of.

Returns

TVertexDescriptor Reference to the source vertex descriptor of stump.

Remarks

A source vertex is not required in an edge stump. However, EdgeStump objects can be configured to contain a source vertex, as in undirected graphs.

Data Races

Thread safety unknown!

TVertexDescriptor target(stump);

Access to the target of an EdgeStump.

Parameters

stump Pointer to the EdgeStump to access the target of.

Returns

TVertexDescriptor Reference to the target vertex descriptor of stump.

Data Races

Thread safety unknown!