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 operations between one or two maps (negation, scaling, 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  SimpleMap
 Simple wrapping of the map. More...
class  SimpleWriteMap
 Simple writeable wrapping of the map. More...
class  AddMap
 Sum of two maps. More...
class  ShiftMap
 Shift a map with a constant. More...
class  ShiftWriteMap
 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  ScaleWriteMap
 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  NegWriteMap
 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  ForkWriteMap
 Applies all map setting operations to two maps. More...
class  NotMap
 Logical 'not' of a map. More...
class  NotWriteMap
 Logical 'not' of a map with writing possibility. More...
class  StoreBoolMap
 Writable bool map for store each true assigned elements. More...
class  BackInserterBoolMap
 Writable bool map for store each true assigned elements in a back insertable container. More...
class  FrontInserterBoolMap
 Writable bool map for store each true assigned elements in a front insertable container. More...
class  InserterBoolMap
 Writable bool map for store each true assigned elements in an insertable container. More...
class  FillBoolMap
 Fill the true set elements with a given value. More...
class  SettingOrderBoolMap
 Writable bool map which stores for each true assigned elements the setting order number. More...

Functions

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


Function Documentation

IdentityMap< T > identityMap (  )  [related, inherited]

This function just returns an IdentityMap class.

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, C > shiftMap ( const M &  m,
const C &  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, C > scaleMap ( const M &  m,
const C &  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, V > 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< F, K, V > 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 Tue Oct 31 09:49:38 2006 for LEMON by  doxygen 1.5.1