ShiftMap Class Template Reference
[Map Adaptors]

#include <lemon/maps.h>

Inherits MapBase< M::Key, M::Value >.

Inheritance diagram for ShiftMap:

Inheritance graph
[legend]
List of all members.

Detailed Description

template<typename M, typename C = typename M::Value>
class lemon::ShiftMap< M, C >

This read only map returns the sum of the given map and a constant value. Its Key and Value is inherited from M.

Actually,

       ShiftMap<X> sh(x,v);
is equivalent with
       ConstMap<X::Key, X::Value> c_tmp(v);
       AddMap<X, ConstMap<X::Key, X::Value> > sh(x,v);


Public Member Functions

 ShiftMap (const M &_m, const C &_v)
 Constructor.

Related Functions

(Note that these are not member functions.)

ShiftMap< M, C > shiftMap (const M &m, const C &v)
 Returns an ShiftMap class.


Constructor & Destructor Documentation

ShiftMap ( const M &  _m,
const C &  _v 
) [inline]

Constructor

Parameters:
_m is the undelying map
_v is the shift value


The documentation for this class was generated from the following file:
Generated on Tue Oct 31 09:51:05 2006 for LEMON by  doxygen 1.5.1