All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Related Functions
ScaleWriteMap< M, C > Class Template Reference

Detailed Description

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

This read-write map returns the value of the given map multiplied from the left side with a constant value. Its Key and Value are inherited from M. It can also be used as write map if the / operator is defined between Value and C and the given multiplier is not zero.

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

See Also
ScaleMap

#include <lemon/maps.h>

+ Inheritance diagram for ScaleWriteMap< 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

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

Related Functions

(Note that these are not member functions.)

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

Constructor & Destructor Documentation

ScaleWriteMap ( M &  m,
const C &  v 
)
inline

Constructor.

Parameters
mThe undelying map.
vThe constant value.