Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

Map Adaptors
[Maps]


Detailed Description

Map adaptors are used to create "implicit" maps from other maps.

Most of them are ReadMaps. They can make arithmetic oprerations between one or two maps (negation, scalig, addition, multiplication etc.) or e.g. convert a map to another one of different Value type.


Classes

class  IdentityMap
 Identity mapping. More...
class  ConvertMap
 Convert the Value of a map to another type. More...
class  AddMap
 Sum of two maps. More...
class  ShiftMap
 Shift a map with a constant. More...
class  SubMap
 Difference of two maps. More...
class  MulMap
 Product of two maps. More...
class  ScaleMap
 Scales a maps with a constant. More...
class  DivMap
 Quotient of two maps. More...
class  ComposeMap
 Composition of two maps. More...
class  CombineMap
 Combines of two maps using an STL (binary) functor. More...
class  NegMap
 Negative value of a map. More...
class  AbsMap
 Absolute value of a map. More...
class  FunctorMap
 Converts an STL style functor to a map. More...
class  MapFunctor
 Converts a map to an STL style (unary) functor. More...
class  ForkMap
 Applies all map setting operations to two maps. More...
class  NotMap
 Logical 'not' of a map. More...

Functions

ConvertMap< M, T > lemon::ConvertMap::convertMap (const M &m)
 Returns an ConvertMap class.
AddMap< M1, M2 > lemon::AddMap::addMap (const M1 &m1, const M2 &m2)
 Returns an AddMap class.
ShiftMap< M > lemon::ShiftMap::shiftMap (const M &m, const typename M::Value &v)
 Returns an ShiftMap class.
SubMap< M1, M2 > lemon::SubMap::subMap (const M1 &m1, const M2 &m2)
 Returns a SubMap class.
MulMap< M1, M2 > lemon::MulMap::mulMap (const M1 &m1, const M2 &m2)
 Returns a MulMap class.
ScaleMap< M > lemon::ScaleMap::scaleMap (const M &m, const typename M::Value &v)
 Returns an ScaleMap class.
DivMap< M1, M2 > lemon::DivMap::divMap (const M1 &m1, const M2 &m2)
 Returns a DivMap class.
ComposeMap< M1, M2 > lemon::ComposeMap::composeMap (const M1 &m1, const M2 &m2)
 Returns a ComposeMap class.
CombineMap< M1, M2, F > lemon::CombineMap::combineMap (const M1 &m1, const M2 &m2, const F &f)
 Returns a CombineMap class.
NegMap< M > lemon::NegMap::negMap (const M &m)
 Returns a NegMap class.
AbsMap< M > lemon::AbsMap::absMap (const M &m)
 Returns a AbsMap class.
FunctorMap< K, V, F > lemon::FunctorMap::functorMap (const F &f)
 Returns a FunctorMap class.
MapFunctor< M > lemon::MapFunctor::mapFunctor (const M &m)
 Returns a MapFunctor class.
ForkMap< M1, M2 > lemon::ForkMap::forkMap (const M1 &m1, const M2 &m2)
 Returns an ForkMap class.
NotMap< M > lemon::NotMap::notMap (const M &m)
 Returns a NotMap class.


Function Documentation

ConvertMap< M, T > convertMap const M &  m  )  [related, inherited]
 

This function just returns an ConvertMap class.

Todo:
The order of the template parameters are changed.

AddMap< M1, M2 > addMap const M1 &  m1,
const M2 &  m2
[related, inherited]
 

This function just returns an AddMap class.

Todo:
How to call these type of functions?
Todo:
Wrong scope in Doxygen when \relates is used

ShiftMap< M > shiftMap const M &  m,
const typename M::Value &  v
[related, inherited]
 

This function just returns an ShiftMap class.

Todo:
A better name is required.

SubMap< M1, M2 > subMap const M1 &  m1,
const M2 &  m2
[related, inherited]
 

This function just returns a SubMap class.

MulMap< M1, M2 > mulMap const M1 &  m1,
const M2 &  m2
[related, inherited]
 

This function just returns a MulMap class.

ScaleMap< M > scaleMap const M &  m,
const typename M::Value &  v
[related, inherited]
 

This function just returns an ScaleMap class.

Todo:
A better name is required.

DivMap< M1, M2 > divMap const M1 &  m1,
const M2 &  m2
[related, inherited]
 

This function just returns a DivMap class.

ComposeMap< M1, M2 > composeMap const M1 &  m1,
const M2 &  m2
[related, inherited]
 

This function just returns a ComposeMap class.

CombineMap< M1, M2, F > combineMap const M1 &  m1,
const M2 &  m2,
const F &  f
[related, inherited]
 

This function just returns a CombineMap class.

Only the first template parameter (the value type) must be given.

For example if m1 and m2 are both double valued maps, then

     combineMap<double>(m1,m2,std::plus<double>)
is equivalent with
     addMap(m1,m2)

NegMap< M > negMap const M &  m  )  [related, inherited]
 

This function just returns a NegMap class.

AbsMap< M > absMap const M &  m  )  [related, inherited]
 

This function just returns a AbsMap class.

FunctorMap< K, V, F > functorMap const F &  f  )  [related, inherited]
 

This function just returns a FunctorMap class.

The third template parameter isn't necessary to be given.

MapFunctor< M > mapFunctor const M &  m  )  [related, inherited]
 

This function just returns a MapFunctor class.

ForkMap< M1, M2 > forkMap const M1 &  m1,
const M2 &  m2
[related, inherited]
 

This function just returns an ForkMap class.

Todo:
How to call these type of functions?
Todo:
Wrong scope in Doxygen when \relates is used

NotMap< M > notMap const M &  m  )  [related, inherited]
 

This function just returns a NotMap class.


Generated on Sat Aug 27 14:14:56 2005 for LEMON by  doxygen 1.4.4