abLEMON 1.9.0-101-gccb8629
A maintained fork of LEMON
Loading...
Searching...
No Matches
ShiftMap< M , C > Class Template Reference

Shifts a map with a constant. More...

#include <lemon/maps.h>

Inheritance diagram for ShiftMap< M , C >:

Public Types

typedef M::Key Key
 
typedef M::Value Value
 
Public Types inherited from MapBase< M::Key , M::Value >
typedef M::Key Key
 The key type of the map.
typedef M::Value Value
 The value type of the map. (The type of objects associated with the keys).

Public Member Functions

 ShiftMap (const M &m, const C &v)
 Constructor.
Value operator[] (const Key &k) const
 

(Note that these are not member symbols.)

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

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 (i.e. it shifts the map with the constant). Its Key and Value are inherited from M.

Actually,

ShiftMap< M > sh( m , v );
ShiftMap( const M & m , const C & v )
Constructor.
Definition maps.h:1085

is equivalent to

Sum of two maps.
Definition maps.h:859
Constant map.
Definition maps.h:110

The simplest way of using this map is through the shiftMap() function.

See also
ShiftWriteMap

Constructor & Destructor Documentation

◆ ShiftMap()

template< typename M , typename C = typename M::Value >
ShiftMap ( const M & m,
const C & v )
inline

Constructor.

Parameters
mThe undelying map.
vThe constant value.