ScaleMap Class Template Reference
[Map Adaptors]

#include <lemon/maps.h>

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

Inheritance diagram for ScaleMap:

Inheritance graph
[legend]
List of all members.

Detailed Description

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

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

Actually,

       ScaleMap<X> sc(x,v);
is equivalent with
       ConstMap<X::Key, X::Value> c_tmp(v);
       MulMap<X, ConstMap<X::Key, X::Value> > sc(x,v);


Public Member Functions

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

Related Functions

(Note that these are not member functions.)

ScaleMap< M, C > scaleMap (const M &m, const C &v)
 Returns an ScaleMap class.


Constructor & Destructor Documentation

ScaleMap const M &  _m,
const C &  _v
[inline]
 

Constructor

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


The documentation for this class was generated from the following file:
Generated on Fri Feb 3 18:42:17 2006 for LEMON by  doxygen 1.4.6