Tulip  5.1.0
Large graphs analysis and drawing
tlp::MinMaxProperty< nodeType, edgeType, propType > Class Template Reference

#include <minmaxproperty.h>

+ Inheritance diagram for tlp::MinMaxProperty< nodeType, edgeType, propType >:
+ Collaboration diagram for tlp::MinMaxProperty< nodeType, edgeType, propType >:

Public Member Functions

 MinMaxProperty (tlp::Graph *graph, const std::string &name, typename nodeType::RealType NodeMin, typename nodeType::RealType NodeMax, typename edgeType::RealType EdgeMin, typename edgeType::RealType EdgeMax)
 
edgeType::RealType getEdgeMax (const Graph *graph=NULL)
 
edgeType::RealType getEdgeMin (const Graph *graph=NULL)
 
nodeType::RealType getNodeMax (const Graph *graph=NULL)
 
nodeType::RealType getNodeMin (const Graph *graph=NULL)
 
virtual void treatEvent (const tlp::Event &ev)
 
void updateAllEdgesValues (typename edgeType::RealType newValue)
 
void updateAllNodesValues (typename nodeType::RealType newValue)
 
template<>
void updateEdgeValue (tlp::edge e, tlp::LineType::RealType newValue)
 
void updateEdgeValue (tlp::edge e, typename edgeType::RealType newValue)
 
void updateNodeValue (tlp::node n, typename nodeType::RealType newValue)
 
- Public Member Functions inherited from tlp::AbstractProperty< nodeType, edgeType, propType >
 AbstractProperty (Graph *, const std::string &n="")
 
int compare (const node n1, const node n2) const
 
int compare (const edge e1, const edge e2) const
 
virtual void computeMetaValue (node n, Graph *sg, Graph *mg)
 
virtual void computeMetaValue (edge e, tlp::Iterator< edge > *itE, Graph *mg)
 
virtual bool copy (const node destination, const node source, PropertyInterface *property, bool ifNotDefault=false)
 
virtual bool copy (const edge destination, const edge source, PropertyInterface *property, bool ifNotDefault=false)
 
virtual void copy (PropertyInterface *property)
 
virtual unsigned int edgeValueSize () const
 
void erase (const node n)
 
void erase (const edge e)
 
virtual DataMem * getEdgeDataMemValue (const edge e) const
 
virtual DataMem * getEdgeDefaultDataMemValue () const
 
virtual std::string getEdgeDefaultStringValue () const
 
edgeType::RealType getEdgeDefaultValue () const
 
virtual tlp::Iterator< edge > * getEdgesEqualTo (typename tlp::StoredType< typename edgeType::RealType >::ReturnedConstValue v, const Graph *g=NULL) const
 
virtual std::string getEdgeStringValue (const edge e) const
 
tlp::StoredType< typename edgeType::RealType >::ReturnedConstValue getEdgeValue (const edge e) const
 
virtual DataMem * getNodeDataMemValue (const node n) const
 
virtual DataMem * getNodeDefaultDataMemValue () const
 
virtual std::string getNodeDefaultStringValue () const
 
nodeType::RealType getNodeDefaultValue () const
 
virtual tlp::Iterator< node > * getNodesEqualTo (typename tlp::StoredType< typename nodeType::RealType >::ReturnedConstValue v, const Graph *g=NULL) const
 
virtual std::string getNodeStringValue (const node n) const
 
tlp::StoredType< typename nodeType::RealType >::ReturnedConstValue getNodeValue (const node n) const
 
virtual DataMem * getNonDefaultDataMemValue (const node n) const
 
virtual DataMem * getNonDefaultDataMemValue (const edge e) const
 
virtual tlp::Iterator< edge > * getNonDefaultValuatedEdges (const Graph *g=NULL) const
 
virtual tlp::Iterator< node > * getNonDefaultValuatedNodes (const Graph *g=NULL) const
 
virtual unsigned int nodeValueSize () const
 
virtual unsigned int numberOfNonDefaultValuatedEdges (const Graph *=NULL) const
 
virtual unsigned int numberOfNonDefaultValuatedNodes (const Graph *g=NULL) const
 
virtual AbstractProperty< nodeType, edgeType, propType > & operator= (AbstractProperty< nodeType, edgeType, propType > &prop)
 
virtual bool readEdgeDefaultValue (std::istream &)
 
virtual bool readEdgeValue (std::istream &, edge)
 
virtual bool readNodeDefaultValue (std::istream &)
 
virtual bool readNodeValue (std::istream &, node)
 
virtual void setAllEdgeDataMemValue (const DataMem *v)
 
virtual bool setAllEdgeStringValue (const std::string &inV)
 
virtual bool setAllEdgeStringValue (const std::string &inV, const Graph *graph)
 
virtual void setAllEdgeValue (typename tlp::StoredType< typename edgeType::RealType >::ReturnedConstValue v)
 
virtual void setAllEdgeValue (typename tlp::StoredType< typename edgeType::RealType >::ReturnedConstValue v, const Graph *graph)
 
virtual void setAllNodeDataMemValue (const DataMem *v)
 
virtual bool setAllNodeStringValue (const std::string &inV)
 
virtual bool setAllNodeStringValue (const std::string &inV, const Graph *graph)
 
virtual void setAllNodeValue (typename tlp::StoredType< typename nodeType::RealType >::ReturnedConstValue v)
 
virtual void setAllNodeValue (typename tlp::StoredType< typename nodeType::RealType >::ReturnedConstValue v, const Graph *graph)
 
virtual void setEdgeDataMemValue (const edge e, const DataMem *v)
 
virtual bool setEdgeDefaultStringValue (const std::string &inV)
 
virtual void setEdgeDefaultValue (typename tlp::StoredType< typename edgeType::RealType >::ReturnedConstValue v)
 
virtual bool setEdgeStringValue (const edge inE, const std::string &inV)
 
virtual void setEdgeValue (const edge e, typename tlp::StoredType< typename edgeType::RealType >::ReturnedConstValue v)
 
virtual void setMetaValueCalculator (PropertyInterface::MetaValueCalculator *mvCalc)
 
virtual void setNodeDataMemValue (const node n, const DataMem *v)
 
virtual bool setNodeDefaultStringValue (const std::string &inV)
 
virtual void setNodeDefaultValue (typename tlp::StoredType< typename nodeType::RealType >::ReturnedConstValue v)
 
virtual bool setNodeStringValue (const node inN, const std::string &inV)
 
virtual void setNodeValue (const node n, typename tlp::StoredType< typename nodeType::RealType >::ReturnedConstValue v)
 
virtual bool setStringValueToGraphEdges (const std::string &inV, const Graph *graph)
 
virtual bool setStringValueToGraphNodes (const std::string &inV, const Graph *graph)
 
virtual void setValueToGraphEdges (typename tlp::StoredType< typename edgeType::RealType >::ReturnedConstValue v, const Graph *graph)
 
virtual void setValueToGraphNodes (typename tlp::StoredType< typename nodeType::RealType >::ReturnedConstValue v, const Graph *graph)
 
virtual void writeEdgeDefaultValue (std::ostream &) const
 
virtual void writeEdgeValue (std::ostream &, edge) const
 
virtual void writeNodeDefaultValue (std::ostream &) const
 
virtual void writeNodeValue (std::ostream &, node) const
 

Protected Member Functions

 MINMAX_MAP (nodeType) minMaxNode
 
 MINMAX_MAP (edgeType) minMaxEdge
 
 MINMAX_PAIR (nodeType) computeMinMaxNode(const Graph *graph)
 
 MINMAX_PAIR (edgeType) computeMinMaxEdge(const Graph *graph)
 
void removeListenersAndClearEdgeMap ()
 
void removeListenersAndClearNodeMap ()
 
- Protected Member Functions inherited from tlp::AbstractProperty< nodeType, edgeType, propType >
virtual void clone_handler (AbstractProperty< nodeType, edgeType, propType > &)
 

Protected Attributes

edgeType::RealType _edgeMax
 
edgeType::RealType _edgeMin
 
nodeType::RealType _nodeMax
 
nodeType::RealType _nodeMin
 
bool needGraphListener
 
- Protected Attributes inherited from tlp::AbstractProperty< nodeType, edgeType, propType >
edgeType::RealType edgeDefaultValue
 
MutableContainer< typename edgeType::RealType > edgeProperties
 
nodeType::RealType nodeDefaultValue
 
MutableContainer< typename nodeType::RealType > nodeProperties
 

Detailed Description

template<typename nodeType, typename edgeType, typename propType = PropertyInterface>
class tlp::MinMaxProperty< nodeType, edgeType, propType >

Abstracts the computation of minimal and maximal values on node and edge values of properties.

The value is lazily computed on first request. The value is cached, and the cache is invalidated whenever it cannot be simply updated.

Definition at line 39 of file minmaxproperty.h.

Constructor & Destructor Documentation

template<typename nodeType , typename edgeType , typename propType >
tlp::MinMaxProperty< nodeType, edgeType, propType >::MinMaxProperty ( tlp::Graph graph,
const std::string &  name,
typename nodeType::RealType  NodeMin,
typename nodeType::RealType  NodeMax,
typename edgeType::RealType  EdgeMin,
typename edgeType::RealType  EdgeMax 
)

Constructs a MinMaxProperty.

Parameters
graphThe graph to attach the property to.
nameThe name of the property.
NodeMinThe minimal value the property can take for nodes (e.g. INT_MIN)
NodeMaxThe maximal value the property can take for nodes (e.g. INT_MIN)
EdgeMinThe minimal value the property can take for edges (e.g. INT_MIN)
EdgeMaxThe maximal value the property can take for edges (e.g. INT_MIN)

Definition at line 23 of file minmaxproperty.cxx.

Member Function Documentation

template<typename nodeType , typename edgeType , typename propType >
edgeType::RealType tlp::MinMaxProperty< nodeType, edgeType, propType >::getEdgeMax ( const Graph graph = NULL)

Computes the maximum value on the edges. It is only computed if it has never been retrieved before, or if the cached value could not be updated.

Parameters
graphThe graph on which to compute.
Returns
The maximal value on this graph for this property.

Definition at line 74 of file minmaxproperty.cxx.

+ Here is the call graph for this function:

template<typename nodeType , typename edgeType , typename propType >
edgeType::RealType tlp::MinMaxProperty< nodeType, edgeType, propType >::getEdgeMin ( const Graph graph = NULL)

Computes the minimum value on the edges. It is only computed if it has never been retrieved before, or if the cached value could not be updated.

Parameters
graphThe graph on which to compute.
Returns
The minimal value on this graph for this property.

Definition at line 59 of file minmaxproperty.cxx.

+ Here is the call graph for this function:

template<typename nodeType , typename edgeType , typename propType >
nodeType::RealType tlp::MinMaxProperty< nodeType, edgeType, propType >::getNodeMax ( const Graph graph = NULL)

Computes the maximum value on the nodes. It is only computed if it has never been retrieved before, or if the cached value could not be updated.

Parameters
graphThe graph on which to compute.
Returns
The maximal value on this graph for this property.

Definition at line 44 of file minmaxproperty.cxx.

+ Here is the call graph for this function:

template<typename nodeType , typename edgeType , typename propType >
nodeType::RealType tlp::MinMaxProperty< nodeType, edgeType, propType >::getNodeMin ( const Graph graph = NULL)

Gets the minimum value on the nodes. It is only computed if it has never been retrieved before, or if the cached value could not be updated.

Parameters
graphThe graph on which to compute.
Returns
The minimal value on this graph for this property.

Definition at line 29 of file minmaxproperty.cxx.

+ Here is the call graph for this function:

template<typename nodeType , typename edgeType , typename propType >
void tlp::MinMaxProperty< nodeType, edgeType, propType >::updateAllEdgesValues ( typename edgeType::RealType  newValue)

Updates the value of all edges, setting the maximum and minimum values to this. Should be called by subclasses in order to keep the cache up to date.

Parameters
newValueThe new maximal and minimal value.

Definition at line 311 of file minmaxproperty.cxx.

+ Here is the call graph for this function:

template<typename nodeType , typename edgeType , typename propType >
void tlp::MinMaxProperty< nodeType, edgeType, propType >::updateAllNodesValues ( typename nodeType::RealType  newValue)

Updates the value of all nodes, setting the maximum and minimum values to this. Should be called by subclasses in order to keep the cache up to date.

Parameters
newValueThe new maximal and minimal value.

Definition at line 299 of file minmaxproperty.cxx.

template<typename nodeType , typename edgeType , typename propType >
void tlp::MinMaxProperty< nodeType, edgeType, propType >::updateEdgeValue ( tlp::edge  e,
typename edgeType::RealType  newValue 
)

Updates the value on an edge, and updates the minimal/maximal cached values if necessary. Should be called by subclasses in order to keep the cache up to date.

Parameters
eThe edge for which the value is updated.
newValueThe new value on this edge.

Definition at line 274 of file minmaxproperty.cxx.

+ Here is the call graph for this function:

template<typename nodeType , typename edgeType , typename propType >
void tlp::MinMaxProperty< nodeType, edgeType, propType >::updateNodeValue ( tlp::node  n,
typename nodeType::RealType  newValue 
)

Updates the value on a node, and updates the minimal/maximal cached values if necessary. Should be called by subclasses in order to keep the cache up to date.

Parameters
nThe node for which the value is updated.
newValueThe new value on this node.

Definition at line 249 of file minmaxproperty.cxx.

+ Here is the call graph for this function: