Detailed Description

This group contains the map structures implemented in LEMON.

LEMON provides several special purpose maps and map adaptors that e.g. combine new maps from existing ones.

Classes
class	MapBase< K, V >
	Base class of maps. More...

class	NullMap< K, V >
	Null map. (a.k.a. DoNothingMap) More...

class	ConstMap< K, V >
	Constant map. More...

class	ConstMap< K, Const< V, v > >
	Constant map with inlined constant value. More...

class	IdentityMap< T >
	Identity map. More...

class	RangeMap< V >
	Map for storing values for integer keys from the range `[0..size-1]`. More...

class	SparseMap< K, V, Comp >
	Map type based on `std::map`. More...

class	TrueMap< K >
	Constant `true` map. More...

class	FalseMap< K >
	Constant `false` map. More...

class	LoggerBoolMap< IT, KEY >
	Writable bool map for logging each `true` assigned element. More...

Modules
	Graph Maps
	Special graph-related maps.

	Map Adaptors
	Tools to create new maps from existing ones.

Files
file	maps.h
	Miscellaneous property maps.

Functions
template<typename K , typename V >
NullMap< K, V >	nullMap ()
	Returns a `NullMap` class.

template<typename K , typename V >
ConstMap< K, V >	constMap (const V &v)
	Returns a `ConstMap` class.

template<typename K , typename V , V v>
ConstMap< K, Const< V, v > >	constMap ()
	Returns a `ConstMap` class with inlined constant value.

template<typename T >
IdentityMap< T >	identityMap ()
	Returns an `IdentityMap` class.

template<typename V >
RangeMap< V >	rangeMap (int size=0, const V &value=V())
	Returns a `RangeMap` class.

template<typename V >
RangeMap< V >	rangeMap (const std::vector< V > &vector)
	Returns a `RangeMap` class created from an appropriate `std::vector`.

template<typename K , typename V , typename Compare >
SparseMap< K, V, Compare >	sparseMap (const V &value=V())
	Returns a `SparseMap` class.

template<typename K , typename V , typename Compare >
SparseMap< K, V, Compare >	sparseMap (const std::map< K, V, Compare > &map, const V &value=V())
	Returns a `SparseMap` class created from an appropriate `std::map`.

template<typename K >
TrueMap< K >	trueMap ()
	Returns a `TrueMap` class.

template<typename K >
FalseMap< K >	falseMap ()
	Returns a `FalseMap` class.

template<typename Iterator >
LoggerBoolMap< Iterator >	loggerBoolMap (Iterator it)
	Returns a `LoggerBoolMap` class.

Function Documentation

NullMap< K, V > nullMap ( )

ConstMap< K, V > constMap ( const V & v )

ConstMap< K, Const< V, v > > constMap ( )

IdentityMap< T > identityMap ( )

RangeMap< V > rangeMap	(	int	size = `0`,
		const V &	value = `V()`
	)

RangeMap< V > rangeMap ( const std::vector< V > & vector )

SparseMap< K, V, Compare > sparseMap ( const V & value = V() )

SparseMap< K, V, Compare > sparseMap	(	const std::map< K, V, Compare > &	map,
		const V &	value = `V()`
	)

TrueMap< K > trueMap ( )

FalseMap< K > falseMap ( )

LoggerBoolMap< Iterator > loggerBoolMap ( Iterator it )

The most important usage of it is storing certain nodes or arcs that were marked true by an algorithm. For example, it makes easier to store the nodes in the processing order of Dfs algorithm, as the following examples show.

std::vector<Node> v;

dfs(g).processedMap(loggerBoolMap(std::back_inserter(v))).run(s);

std::vector<Node> v(countNodes(g));

dfs(g).processedMap(loggerBoolMap(v.begin())).run(s);

Note: The container of the iterator must contain enough space for the elements or the iterator should be an inserter iterator.; LoggerBoolMap is just writable, so it cannot be used when a readable map is needed, for example, as ReachedMap for Bfs, Dfs and Dijkstra algorithms.

Detailed Description

Classes

Modules

Files

Functions

Function Documentation