Metafunction
VertexDescriptor
Type of an object that represents a vertex descriptor.
VertexDescriptor<T>::Type
Include Headers
seqan/basic.h
Parameters

T | Type T must be a graph. All graphs currently use ids as vertex descriptors. Types: EdgeStump, Graph, IndexEsa, IndexWotd

Remarks
The vertex descriptor is a unique handle to a vertex in a graph. It is used in various graph functions, e.g., to add edges, to create OutEdge Iterators or to remove a vertex. It is also used to attach properties to vertices.
Return Values

Type | VertexDescriptor type.

Member of
IndexEsa, Graph, EdgeStump
Functions

addChild | Adds a new child vertex to a parent vertex. Optionally a cargo can be attached to the parent-child edge.
addEdge | Adds a new edge to the graph, either with or without cargo.
addEdges | Shortcut to add multiple edges at once. Creates vertices implicitly.
addVertex | Adds a new vertex to the graph.
assignBeginState | Assigns a begin state.
assignEmissionProbability | Assigns a new emission probability.
assignEndState | Assigns an end state.
assignProperty | Assigns a property to an item in the property map.
assignRoot | Assigns a new root vertex to the graph.
assignSilentStatus | Assigns a silent status to a state.
assignTransitionProbability | Assigns a new transition probability to an existing edge.
bellmanFordAlgorithm | Computes shortest paths from a single source in a directed graph.
breadthFirstSearch | Implements a breadth-first search on a graph.
canParseString | Test whether an automaton can parse a string completely.
childVertex | Returns the child vertex of an edge.
collectLeaves | Returns all leaves underneath a given vertex.
dagShortestPath | Computes shortest paths from a single source in a directed acyclic graph (DAG).
degree | Number of incident edges for a given vertex.
dijkstra | Computes shortest paths from a single source in a graph.
emissionProbability | Returns a reference to the emission probability.
findEdge | Finds an edge.
fordFulkersonAlgorithm | Computes a maximum flow in a directed graph.
fragmentBegin | Gets the begin position for this fragment or this vertex descriptor in the sequence.
fragmentLength | Gets the length of the label of a given vertex descriptor in the sequence.
getEmissionProbability | Returns the emission probability.
getProperty | Get method for an item's property.
getRoot | Get method for the root of a tree or an automaton.
getSuccessor | Gets the successor for a given vertex and an edge label. For an automaton a single character is required whereas for a word graph getSuccessor takes a string.
getTransitionProbability | Returns the transition probability.
inDegree | Number of incoming edges for a given vertex.
isLeaf | Tests whether a given vertex is a leaf or not.
isRoot | Tests whether a given vertex is the root or not.
isSilent | Indicates whether a state is silent or not.
kruskalsAlgorithm | Computes a minimum spanning tree on a graph.
label | Gets the label that is associated with this vertex descriptor.
nodeUp | Returns the vertex descriptor of the parent node.
numChildren | Number of children of a given tree vertex.
outDegree | Number of outgoing edges for a given vertex.
parentVertex | Returns the parent vertex of an edge or vertex.
parseString | Parses a string one character at a time and moves accordingly in the automaton.
primsAlgorithm | Computes a minimum spanning tree on a graph.
property | Accesses the property of an item in the property map.
removeAllChildren | Removes all children from the tree given a parent.
removeChild | Removes a child from the tree given a parent.
removeEdge | Removes an edge from the graph. For automatons a label is required.
removeInEdges | Removes the incoming edges of a given vertex.
removeOutEdges | Removes the outgoing edges of a given vertex.
removeVertex | Removes a vertex.
root | Gets a reference to the root of the tree.
sequenceId | Gets the sequence id that is associated with this vertex descriptor or with a sequence of a fragment.
silentStatus | Reference to the silent status of a state.
sourceVertex | Returns the source vertex of an edge.
targetVertex | Returns the target vertex of an edge.
transitionProbability | Returns a reference to the transition probability.

Examples
VertexDescriptor<Graph<> >::Type vD; //vD is a vertex descriptor
SeqAn - Sequence Analysis Library - www.seqan.de

Page built @2014/10/13 16:12:59