Class
EdgeStump
The EdgeStump class encapsulates a single edge. It represents either a list node in the adjacency list of a graph or an array field if edges are stored in an array.
EdgeStump<TCargo, bool TList, bool TSource, bool TId, TSpec>
Include Headers
seqan/graph_types.h
Parameters

TCargo | The cargo type of an edge. Metafunctions: Cargo Default: void Remarks: The cargo can be used to store arbitrary information with an edge.
TList | Boolean value that indicates whether it is a list node or not. Default: true Remarks: If it is a list node it has one or two next pointers.
TSource | Boolean value that indicates whether the source is stored in the EdgeStump or not. Default: false Remarks: If this value is true and it is a list node an additional source next pointer is present.
TId | Boolean value that indicates whether an id is stored in the EdgeStump or not. Note: Without edge ids external property maps do not work for edges! Default: true
TSpec | The specializing type. Metafunctions: Spec Default: Default, see Default.

Remarks
The default EdgeStump in all graph types does not consider a cargo. However, in 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.
Metafunctions

Cargo | Type of additional data stored in an object.
EdgeIdHandler | Type of an object that represents an Id Manager.
Spec | The spec of a class.
VertexDescriptor | Type of an object that represents a vertex descriptor.

Functions

assignCargo | Assigns a new cargo to the edge.
assignNextS | Assigns another EdgeStump to the next source pointer.
assignNextS | Assigns another EdgeStump to the next source pointer.
assignNextT | Assigns another EdgeStump to the next target pointer.
assignNextT | Assigns another EdgeStump to the next target pointer.
assignSource | Assigns a source vertex to an edge.
assignTarget | Assigns a target vertex to an edge.
cargo | Access to the cargo.
getCargo | Get method for the edge cargo.
getNextS | Get method for the next source pointer.
getNextT | Get method for the next target pointer.
getSource | Get method for the source.
getTarget | Get method for the target.
nextS | Accesses the next source pointer.
nextT | Accesses the next target pointer.
target | Accesses the target of an EdgeStump.

SeqAn - Sequence Analysis Library - www.seqan.de

Page built @2012/03/14 16:34:45