Tulip  5.2.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=nullptr)
 
edgeType::RealType getEdgeMin (const Graph *graph=nullptr)
 
nodeType::RealType getNodeMax (const Graph *graph=nullptr)
 
nodeType::RealType getNodeMin (const Graph *graph=nullptr)
 
void treatEvent (const tlp::Event &ev) override
 
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 override
 
int compare (const edge e1, const edge e2) const override
 
void computeMetaValue (node n, Graph *sg, Graph *mg) override
 
void computeMetaValue (edge e, tlp::Iterator< edge > *itE, Graph *mg) override
 
bool copy (const node destination, const node source, PropertyInterface *property, bool ifNotDefault=false) override
 
bool copy (const edge destination, const edge source, PropertyInterface *property, bool ifNotDefault=false) override
 
void copy (PropertyInterface *property) override
 
unsigned int edgeValueSize () const override
 
void erase (const node n) override
 
void erase (const edge e) override
 
DataMem * getEdgeDataMemValue (const edge e) const override
 
DataMem * getEdgeDefaultDataMemValue () const override
 
std::string getEdgeDefaultStringValue () const override
 
edgeType::RealType getEdgeDefaultValue () const
 
virtual tlp::Iterator< edge > * getEdgesEqualTo (typename tlp::StoredType< typename edgeType::RealType >::ReturnedConstValue v, const Graph *g=nullptr) const
 
std::string getEdgeStringValue (const edge e) const override
 
tlp::StoredType< typename edgeType::RealType >::ReturnedConstValue getEdgeValue (const edge e) const
 
DataMem * getNodeDataMemValue (const node n) const override
 
DataMem * getNodeDefaultDataMemValue () const override
 
std::string getNodeDefaultStringValue () const override
 
nodeType::RealType getNodeDefaultValue () const
 
virtual tlp::Iterator< node > * getNodesEqualTo (typename tlp::StoredType< typename nodeType::RealType >::ReturnedConstValue v, const Graph *g=nullptr) const
 
std::string getNodeStringValue (const node n) const override
 
tlp::StoredType< typename nodeType::RealType >::ReturnedConstValue getNodeValue (const node n) const
 
DataMem * getNonDefaultDataMemValue (const node n) const override
 
DataMem * getNonDefaultDataMemValue (const edge e) const override
 
tlp::Iterator< edge > * getNonDefaultValuatedEdges (const Graph *g=nullptr) const override
 
tlp::Iterator< node > * getNonDefaultValuatedNodes (const Graph *g=nullptr) const override
 
bool hasNonDefaultValuatedEdges (const Graph *g=nullptr) const override
 
bool hasNonDefaultValuatedNodes (const Graph *g=nullptr) const override
 
unsigned int nodeValueSize () const override
 
unsigned int numberOfNonDefaultValuatedEdges (const Graph *=nullptr) const override
 
unsigned int numberOfNonDefaultValuatedNodes (const Graph *g=nullptr) const override
 
virtual AbstractProperty< nodeType, edgeType, propType > & operator= (AbstractProperty< nodeType, edgeType, propType > &prop)
 
bool readEdgeDefaultValue (std::istream &) override
 
bool readEdgeValue (std::istream &, edge) override
 
bool readNodeDefaultValue (std::istream &) override
 
bool readNodeValue (std::istream &, node) override
 
void setAllEdgeDataMemValue (const DataMem *v) override
 
bool setAllEdgeStringValue (const std::string &inV) override
 
bool setAllEdgeStringValue (const std::string &inV, const Graph *graph) override
 
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)
 
void setAllNodeDataMemValue (const DataMem *v) override
 
bool setAllNodeStringValue (const std::string &inV) override
 
bool setAllNodeStringValue (const std::string &inV, const Graph *graph) override
 
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)
 
void setEdgeDataMemValue (const edge e, const DataMem *v) override
 
bool setEdgeDefaultStringValue (const std::string &inV) override
 
virtual void setEdgeDefaultValue (typename tlp::StoredType< typename edgeType::RealType >::ReturnedConstValue v)
 
bool setEdgeStringValue (const edge inE, const std::string &inV) override
 
virtual void setEdgeValue (const edge e, typename tlp::StoredType< typename edgeType::RealType >::ReturnedConstValue v)
 
void setMetaValueCalculator (PropertyInterface::MetaValueCalculator *mvCalc) override
 
void setNodeDataMemValue (const node n, const DataMem *v) override
 
bool setNodeDefaultStringValue (const std::string &inV) override
 
virtual void setNodeDefaultValue (typename tlp::StoredType< typename nodeType::RealType >::ReturnedConstValue v)
 
bool setNodeStringValue (const node inN, const std::string &inV) override
 
virtual void setNodeValue (const node n, typename tlp::StoredType< typename nodeType::RealType >::ReturnedConstValue v)
 
bool setStringValueToGraphEdges (const std::string &inV, const Graph *graph) override
 
bool setStringValueToGraphNodes (const std::string &inV, const Graph *graph) override
 
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)
 
void writeEdgeDefaultValue (std::ostream &) const override
 
void writeEdgeValue (std::ostream &, edge) const override
 
void writeNodeDefaultValue (std::ostream &) const override
 
void writeNodeValue (std::ostream &, node) const override
 

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 40 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 = nullptr)

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 80 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 = nullptr)

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 64 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 = nullptr)

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 48 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 = nullptr)

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 32 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 300 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 287 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 261 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 235 of file minmaxproperty.cxx.

+ Here is the call graph for this function: