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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
TEdgeStump nextT(es);
Accesses the next target pointer.
Parameters
es
|
Pointer to the EdgeStump. |
Returns
TEdgeStump |
Reference to the next target pointer. |
Data Races
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.