Path Structures

The same group on the Doxygen site.

group Path Structures

Path structures implemented in LEMON.

This group contains the path structures implemented in LEMON.

LEMON provides flexible data structures to work with paths. All of them have similar interfaces and they can be copied easily with assignment operators and copy constructors. This makes it easy and efficient to have e.g. the Dijkstra algorithm to store its result in any kind of path structure.

See also

Path concept

Classes

Class

Description

Path

A structure for representing directed paths in a digraph.

SimplePath

A structure for representing directed paths in a digraph.

ListPath

A structure for representing directed paths in a digraph.

StaticPath

A structure for representing directed paths in a digraph.

PathNodeIt

Class for iterating through the nodes of a path.

Functions and other members

template< typename From , typename To >
void pathCopy( const From & from , To & to )

Make a copy of a path.

This function makes a copy of a path.

template< typename To , typename From >
void copyPath( To & to , const From & from )

Deprecated version of pathCopy().

Deprecated version of pathCopy() (only for reverse compatibility).

template< typename Digraph , typename Path >
bool checkPath(
const Digraph & digraph,
const Path & path
)

Check the consistency of a path.

This function checks that the target of each arc is the same as the source of the next one.

template< typename Digraph , typename Path >
Digraph::Node pathSource(
const Digraph & digraph,
const Path & path
)

The source of a path.

This function returns the source node of the given path. If the path is empty, then it returns INVALID.

template< typename Digraph , typename Path >
Digraph::Node pathTarget(
const Digraph & digraph,
const Path & path
)

The target of a path.

This function returns the target node of the given path. If the path is empty, then it returns INVALID.

template< typename Path >
LemonRangeWrapper2< PathNodeIt< Path > , typename Path::Digraph , Path > pathNodes(
const typename Path::Digraph & g,
const Path & p
)

Gets the collection of the nodes of the path.

This function can be used for iterating on the nodes of the path. It returns a wrapped PathNodeIt, which looks like an STL container (by having begin() and end()) which you can use in range-based for loops, STL algorithms, etc. For example you can write:

for( auto u : pathNodes( g , p ) )
 doSomething( u );