ListPath

Declared in lemon/path.h, in the group Path Structures; the same class on the Doxygen site.

template< typename GR >
class ListPath

A structure for representing directed paths in a digraph.

A structure for representing directed path in a digraph.

In a sense, a path can be treated as a list of arcs. The LEMON path type simply stores this list. As a consequence, it cannot enumerate the nodes in the path, and the source node of a zero-length path is undefined.

This implementation is a back and front insertable and erasable path type. It can be indexed in O(k) time, where k is the rank of the arc in the path. The length can be computed in O(n) time. The front and back insertion and erasure is O(1) time and it can be splited and spliced in O(1) time.

Template Parameters:

GR – The digraph type in which the path is.

Public Types

typedef GR Digraph
typedef Digraph::Arc Arc
typedef True BuildTag

Public Functions

inline ListPath()

Default constructor

inline ListPath( const ListPath & cpath )

Copy constructor.

template< typename CPath >
inline ListPath( const CPath & cpath )

Template copy constructor.

This path can be initialized with any other path type. It just makes a copy of the given path.

inline ~ListPath()

Destructor of the path

inline ListPath & operator=( const ListPath & cpath )

Copy assignment.

template< typename CPath >
inline ListPath & operator=( const CPath & cpath )

Template copy assignment.

This path can be initialized with any other path type. It just makes a copy of the given path.

inline LemonRangeWrapper1< ArcIt , ListPath > arcs() const

Gets the collection of the arcs of the path.

This function can be used for iterating on the arcs of the path. It returns a wrapped ArcIt, 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 a : p.arcs() )
 doSomething( a );

inline const Arc & nth( int n ) const

The n-th arc.

This function looks for the n-th arc in O(n) time.

Pre:

n is in the range [0..length() - 1].

inline ArcIt nthIt( int n ) const

Initializes arc iterator to point to the n-th arc.

inline const Arc & operator[]( int n ) const

The n-th arc.

Looks for the n-th arc in O(n) time. This operator is just an alias for nth().

Pre:

n is in the range [0..length() - 1].

inline int length() const

Length of the path.

inline bool empty() const

Return true if the path is empty.

inline void clear()

Reset the path to an empty one.

inline const Arc & front() const

The first arc of the path.

inline void addFront( const Arc & arc )

Add a new arc before the current path.

inline void eraseFront()

Erase the first arc of the path.

inline const Arc & back() const

The last arc of the path.

inline void addBack( const Arc & arc )

Add a new arc behind the current path.

inline void eraseBack()

Erase the last arc of the path.

inline void spliceBack( ListPath & tpath )

Splice a path to the back of the current path.

It splices tpath to the back of the current path and tpath becomes empty. The time complexity of this function is O(1).

inline void spliceFront( ListPath & tpath )

Splice a path to the front of the current path.

It splices tpath before the current path and tpath becomes empty. The time complexity of this function is O(1).

inline void splice( ArcIt it , ListPath & tpath )

Splice a path into the current path.

It splices the tpath into the current path before the position of it iterator and tpath becomes empty. The time complexity of this function is O(1). If the it is INVALID then it will splice behind the current path.

inline void split( ArcIt it , ListPath & tpath )

Split the current path.

It splits the current path into two parts. The part before the iterator it will remain in the current path and the part starting with it will put into tpath. If tpath have arcs before the operation they are removed first. The time complexity of this function is O(1) plus the time of emtying tpath. If it is INVALID then it just clears tpath

template< typename CPath >
inline void build( const CPath & path )
template< typename CPath >
inline void buildRev( const CPath & path )

Protected Types

typedef std::allocator_traits< std::allocator< Node > > AllocTraits

Protected Attributes

Node * first
Node * last
std::allocator< Node > alloc
struct Node

Public Members

Arc arc
Node * next
Node * prev
class ArcIt

Iterator class to iterate on the arcs of the paths.

This class is used to iterate on the arcs of the paths

Of course it converts to Digraph::Arc

Public Functions

inline ArcIt()

Default constructor.

inline ArcIt(Invalid)

Invalid constructor.

inline ArcIt( const ListPath & _path )

Initializate the constructor to the first arc of path.

inline operator const Arc&() const

Conversion to Digraph::Arc.

inline ArcIt & operator++()

Next arc.

inline bool operator==( const ArcIt & e ) const

Comparison operator.

inline bool operator!=( const ArcIt & e ) const

Comparison operator.

inline bool operator<( const ArcIt & e ) const

Comparison operator.

Protected Functions

inline ArcIt( const ListPath & _path , Node * _node )