PotentialDifferenceMap< GR, POT > Class Template Reference

Detailed Description

template<typename GR, typename POT>
class lemon::PotentialDifferenceMap< GR, POT >

PotentialDifferenceMap returns the difference between the potentials of the source and target nodes of each arc in a digraph, i.e. it returns

*    potential[gr.target(arc)] - potential[gr.source(arc)].
*  

Template Parameters

GR	The digraph type.
POT	A node map storing the potentials.

#include <lemon/maps.h>

Public Types
typedef GR::Arc	Key
	Key type.
typedef POT::Value	Value
	Value type.

Public Member Functions
	PotentialDifferenceMap (const GR &gr, const POT &potential)
	Constructor. More...
Value	operator[] (const Key &arc) const
	Returns the potential difference for the given arc. More...

Related Functions
(Note that these are not member functions.)
template<typename GR , typename POT >
PotentialDifferenceMap< GR, POT >	potentialDifferenceMap (const GR &gr, const POT &potential)
	Returns a PotentialDifferenceMap. More...

Constructor & Destructor Documentation

PotentialDifferenceMap ( const GR &  gr, const POT &  potential  )

inlineexplicit

Contructor of the map.

Member Function Documentation

Value operator[] ( const Key &  arc ) const

inline

Returns the potential difference for the given arc, i.e.

*    potential[gr.target(arc)] - potential[gr.source(arc)].
*