Maps
[Data Structures]

---

Detailed Description

This group describes the map structures implemented in LEMON.

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

Classes
class	XMap< M >
class	ConstXMap< M >
	Constant (read only) version of XMap. More...
class	YMap< M >
class	ConstYMap< M >
	Constant (read only) version of YMap. More...
class	NormSquareMap< M >
class	MapBase< K, T >
	Base class of maps. More...
class	NullMap< K, T >
	Null map. (a.k.a. DoNothingMap). More...
class	ConstMap< K, T >
	Constant map. More...
class	ConstMap< K, Const< V, v > >
	Constant map with inlined constant value. More...
class	StdMap< K, T, Compare >
	Map based on std::map. More...
class	IntegerMap< T >
	Map for storing values for keys from the range [0..size-1]. More...
Modules
	Graph Maps
	Special Graph-Related Maps.
	Map Adaptors
	Tools to create new maps from existing ones.
Files
file	iterable_maps.h
	Maps that makes it possible to iterate through the keys having a certain value.
file	maps.h
	Miscellaneous property maps.
Functions
template<class M >
XMap< M >	xMap (M &m)
	Returns an XMap class.
template<class M >
ConstXMap< M >	xMap (const M &m)
	Returns a ConstXMap class.
template<class M >
YMap< M >	yMap (M &m)
	Returns a YMap class.
template<class M >
ConstYMap< M >	yMap (const M &m)
	Returns a ConstYMap class.
template<class M >
NormSquareMap< M >	normSquareMap (const M &m)
	Returns a NormSquareMap class.
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 value.
template<typename K , typename V , typename Compare >
StdMap< K, V, Compare >	stdMap (const V &value=V())
	Returns a StdMap class.
template<typename K , typename V , typename Compare >
StdMap< K, V, Compare >	stdMap (const std::map< K, V, Compare > &map, const V &value=V())
	Returns a StdMap class created from an appropriate std::map.
template<typename T >
IntegerMap< T >	integerMap (int size=0, const T &value=T())
	Returns an IntegerMap class.

---

Function Documentation

XMap< M > xMap

(

M &

m

)

[related, inherited]

This function just returns an XMap class.

ConstXMap< M > xMap

(

const M &

m

)

[related, inherited]

This function just returns a ConstXMap class.

YMap< M > yMap

(

M &

m

)

[related, inherited]

This function just returns a YMap class.

ConstYMap< M > yMap

(

const M &

m

)

[related, inherited]

This function just returns a ConstYMap class.

NormSquareMap< M > normSquareMap

(

const M &

m

)

[related, inherited]

This function just returns a NormSquareMap class.

NullMap< K, V > nullMap

(

)

[related, inherited]

This function just returns a NullMap class.

ConstMap< K, V > constMap

(

const V &

v

)

[related, inherited]

This function just returns a ConstMap class.

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

(

)

[related, inherited]

This function just returns a ConstMap class with inlined value.

StdMap< K, V, Compare > stdMap

(

const V &

value = V()

)

[related, inherited]

This function just returns a StdMap class with specified default value.

StdMap< K, V, Compare > stdMap	(	const std::map< K, V, Compare > &	map,
		const V &	value = V()
	)			[related, inherited]

This function just returns a StdMap class created from an appropriate std::map.

IntegerMap< T > integerMap	(	int	size = 0,
		const T &	value = T()
	)			[related, inherited]

This function just returns an IntegerMap class.