GraphReader

Declared in lemon/lgf_reader.h, in the group LEMON Graph Format; the same class on the Doxygen site.

template< typename GR >
class GraphReader

LGF reader for undirected graphs

This utility reads an LGF file.

It can be used almost the same way as DigraphReader. The only difference is that this class can handle edges and edge maps as well as arcs and arc maps.

The columns in the @edges (or @arcs) section are the edge maps. However, if there are two maps with the same name prefixed with '+' and '-', then these can be read into an arc map. Similarly, an attribute can be read into an arc, if it’s value is an edge label prefixed with '+' or '-'.

Reading Rules

template< typename Map >
inline GraphReader & nodeMap( const std::string & caption , Map & map )

Node map reading rule.

Add a node map reading rule to the reader.

template< typename Map , typename Converter >
inline GraphReader & nodeMap(
const std::string & caption,
Map & map,
const Converter & converter = Converter()
)

Node map reading rule.

Add a node map reading rule with specialized converter to the reader.

template< typename Map >
inline GraphReader & edgeMap( const std::string & caption , Map & map )

Edge map reading rule.

Add an edge map reading rule to the reader.

template< typename Map , typename Converter >
inline GraphReader & edgeMap(
const std::string & caption,
Map & map,
const Converter & converter = Converter()
)

Edge map reading rule.

Add an edge map reading rule with specialized converter to the reader.

template< typename Map >
inline GraphReader & arcMap( const std::string & caption , Map & map )

Arc map reading rule.

Add an arc map reading rule to the reader.

template< typename Map , typename Converter >
inline GraphReader & arcMap(
const std::string & caption,
Map & map,
const Converter & converter = Converter()
)

Arc map reading rule.

Add an arc map reading rule with specialized converter to the reader.

template< typename Value >
inline GraphReader & attribute(
const std::string & caption,
Value & value
)

Attribute reading rule.

Add an attribute reading rule to the reader.

template< typename Value , typename Converter >
inline GraphReader & attribute(
const std::string & caption,
Value & value,
const Converter & converter = Converter()
)

Attribute reading rule.

Add an attribute reading rule with specialized converter to the reader.

inline GraphReader & node( const std::string & caption , Node & node )

Node reading rule.

Add a node reading rule to reader.

inline GraphReader & edge( const std::string & caption , Edge & edge )

Edge reading rule.

Add an edge reading rule to reader.

inline GraphReader & arc( const std::string & caption , Arc & arc )

Arc reading rule.

Add an arc reading rule to reader.

Select Section by Name

inline GraphReader & nodes( const std::string & caption )

Set @nodes section to be read.

inline GraphReader & edges( const std::string & caption )

Set @edges section to be read.

inline GraphReader & attributes( const std::string & caption )

Set @attributes section to be read.

Using Previously Constructed Node or Edge Set

template< typename Map >
inline GraphReader & useNodes( const Map & map )

Use previously constructed node set.

Use previously constructed node set, and specify the node label map.

template< typename Map , typename Converter >
inline GraphReader & useNodes(
const Map & map,
const Converter & converter = Converter()
)

Use previously constructed node set.

Use previously constructed node set, and specify the node label map and a functor which converts the label map values to std::string.

template< typename Map >
inline GraphReader & useEdges( const Map & map )

Use previously constructed edge set.

Use previously constructed edge set, and specify the edge label map.

template< typename Map , typename Converter >
inline GraphReader & useEdges(
const Map & map,
const Converter & converter = Converter()
)

Use previously constructed edge set.

Use previously constructed edge set, and specify the edge label map and a functor which converts the label map values to std::string.

inline GraphReader & skipNodes()

Skip the reading of node section.

Omit the reading of the node section. This implies that each node map reading rule will be abandoned, and the nodes of the graph will not be constructed, which usually cause that the edge set could not be read due to lack of node name could not be read due to lack of node name resolving. Therefore skipEdges() function should also be used, or useNodes() should be used to specify the label of the nodes.

inline GraphReader & skipEdges()

Skip the reading of edge section.

Omit the reading of the edge section. This implies that each edge map reading rule will be abandoned, and the edges of the graph will not be constructed.

Execution of the Reader

inline void run()

Start the batch processing.

This function starts the batch processing

Public Types

typedef GR Graph

Public Functions

inline GraphReader( GR & graph , std::istream & is = std::cin )

Constructor.

Construct an undirected graph reader, which reads from the given input stream.

inline GraphReader( GR & graph , const std::string & fn )

Constructor.

Construct an undirected graph reader, which reads from the given file.

inline GraphReader( GR & graph , const char * fn )

Constructor.

Construct an undirected graph reader, which reads from the given file.

inline ~GraphReader()

Destructor.

template< typename TGR >
GraphReader< TGR > graphReader( TGR & graph , const std::string & fn )

Return a GraphReader class.

This function just returns a GraphReader class.

See also

graphReader( TGR & graph , std::istream & is )

template< typename TGR >
GraphReader< TGR > graphReader( TGR & graph , const char * fn )

Return a GraphReader class.

This function just returns a GraphReader class.

See also

graphReader( TGR & graph , std::istream & is )