Abstract Graph of Node. More...

#include <Graph.h>

Public Member Functions
void	clearAll ()

void	clearFirstNode ()
	Clear the list of first Node.

void	clearIsUpdated ()
	Clear the isUpdated attriburte of the Node.

void	clearLastNode ()
	Clear the list of last Node.

void	clearMapNode ()
	Clear the map of Node.

void	connectNode (UIdx parent, const std::list< UIdx > &listChildren)
	Connect a parent to its children.

void	connectNode (UIdx parent, const std::vector< UIdx > &vecChildren)
	Connect a parent to its children.

void	connectNode (UIdx parent, UIdx child)
	Connect a parent to its child.

UIdx	createNode (const T &data, const std::string &name)
	Create a node and get its index.

bool	createNode (const T &data, const UIdx &index, const std::string &name)
	Create a node and get its index.

Node< T, UIdx > *	createNodePtr (const T &data, const std::string &name)
	Create a node and get its pointer.

Node< T, UIdx > *	createNodePtr (const T &data, const UIdx &index, const std::string &name)
	Create a node and get its pointer.

Node< T, UIdx > *	getFirstNotUpdatedNode ()
	Get the first node which is not udpated (getIsUpdated() == false)

const Node< T, UIdx > *	getFirstNotUpdatedNode () const
	Get the first node which is not udpated (getIsUpdated() == false)

const std::list< UIdx > &	getListFirstNode () const
	Get the list of the first nodes (without parent)

const std::list< UIdx > &	getListLastNode () const
	Get the list of the last nodes (without child)

Node< T, UIdx > *	getNode (UIdx index)
	Get a Node by pointer.

const Node< T, UIdx > *	getNode (UIdx index) const
	Get a Node by pointer.

	Graph ()
	Default constructeur of Graph.

	Graph (const Graph< T, UIdx > &other)
	Copy constructor of Graph.

bool	isListNodeUdpated (const std::list< UIdx > &listNode) const
	Check if the list of given nodes are all updated or not.

bool	isNodeExist (UIdx index) const
	Say if the node at index does exit.

bool	iterateChildren (std::list< UIdx > &listNode) const
	Iterate from parents to chidren.

bool	iterateChildrenCheckUpdate (std::list< UIdx > &listNode)
	Iterate from parents to chidren (all node are iterated only once)

bool	iterateParent (std::list< UIdx > &listNode) const
	Iterate from children to parents.

bool	iterateParentCheckUpdate (std::list< UIdx > &listNode)
	Iterate from children to parents (all node are iterated only once)

Graph &	operator= (const Graph< T, UIdx > &other)
	Definition of equal operator of Graph.

void	removeNode (UIdx index, bool reconnectParentToChildren=false)
	Remove a Node from the Graph.

bool	saveDot (const std::string &fileName) const
	Save the Graph in a dot file.

bool	saveDot (std::ofstream &fs) const
	Save the Graph in a dot file.

bool	savePng (const std::string &fileNamePng) const
	Save a png file of the graph.

size_t	size () const
	Get the number of nodes inside the graph.

std::string	toDot () const
	Convert the graph to dot language.

void	updateFirstLastNode ()
	Update the first and last Node of the Graph.

virtual	~Graph ()
	Destructeur of Graph.

Protected Member Functions
void	copyGraph (const Graph< T, UIdx > &other)
	Copy function of Graph.

Private Member Functions
void	initialisationGraph ()
	Initialisation function of the class Graph.

Private Attributes
std::list< UIdx >	p_listFirstNode
	List of the first Node (without parent)

std::list< UIdx >	p_listLastNode
	List of the last Node (without child)

std::map< UIdx, Node< T, UIdx > >	p_mapNode
	Map of the Node.

Detailed Description

template<typename T, typename UIdx>
class Graph< T, UIdx >

Abstract Graph of Node.

T : type of the data to be connected in the graph UIdx : type of the index to be used to connect the Node together

Definition at line 20 of file Graph.h.

Constructor & Destructor Documentation

◆ Graph() [1/2]

template<typename T, typename UIdx>

Graph< T, UIdx >::Graph ( )

Default constructeur of Graph.

Definition at line 17 of file Graph_impl.h.

                     {
        initialisationGraph();
}

References initialisationGraph().

Referenced by copyGraph(), Graph(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Graph() [2/2]

template<typename T, typename UIdx>

Graph< T, UIdx >::Graph ( const Graph< T, UIdx > & other )

Copy constructor of Graph.

Parameters

other : class to copy

Definition at line 25 of file Graph_impl.h.

                                                 {
        copyGraph(other);
}

References copyGraph(), and Graph().

Here is the call graph for this function:

◆ ~Graph()

template<typename T, typename UIdx>

Graph< T, UIdx >::~Graph ( )

virtual

Destructeur of Graph.

Definition at line 31 of file Graph_impl.h.

                      {
        
}

Member Function Documentation

◆ clearAll()

template<typename T, typename UIdx>

void Graph< T, UIdx >::clearAll ( )

Definition at line 199 of file Graph_impl.h.

                             {
        clearFirstNode();
        clearLastNode();
        clearMapNode();
}

References clearFirstNode(), clearLastNode(), and clearMapNode().

Here is the call graph for this function:

◆ clearFirstNode()

template<typename T, typename UIdx>

void Graph< T, UIdx >::clearFirstNode ( )

Clear the list of first Node.

Definition at line 191 of file Graph_impl.h.

191{p_listFirstNode.clear();}

Graph::p_listFirstNode

std::list< UIdx > p_listFirstNode

List of the first Node (without parent)

Definition Graph.h:80

References p_listFirstNode.

Referenced by clearAll(), and updateFirstLastNode().

Here is the caller graph for this function:

◆ clearIsUpdated()

template<typename T, typename UIdx>

void Graph< T, UIdx >::clearIsUpdated ( )

Clear the isUpdated attriburte of the Node.

Definition at line 179 of file Graph_impl.h.

                                   {
        for(typename std::map<UIdx, Node<T, UIdx> >::iterator it(p_mapNode.begin()); it != p_mapNode.end(); ++it){
                it->second.setIsUpdated(false);
        }
}

References p_mapNode.

Referenced by iterateChildrenCheckUpdate(), and iterateParentCheckUpdate().

Here is the caller graph for this function:

◆ clearLastNode()

template<typename T, typename UIdx>

void Graph< T, UIdx >::clearLastNode ( )

Clear the list of last Node.

Definition at line 195 of file Graph_impl.h.

195{p_listLastNode.clear();}

Graph::p_listLastNode

std::list< UIdx > p_listLastNode

List of the last Node (without child)

Definition Graph.h:82

References p_listLastNode.

Referenced by clearAll(), and updateFirstLastNode().

Here is the caller graph for this function:

◆ clearMapNode()

template<typename T, typename UIdx>

void Graph< T, UIdx >::clearMapNode ( )

Clear the map of Node.

Definition at line 187 of file Graph_impl.h.

187{p_mapNode.clear();}

References p_mapNode.

Referenced by clearAll().

Here is the caller graph for this function:

◆ connectNode() [1/3]

template<typename T, typename UIdx>

void Graph< T, UIdx >::connectNode	(	UIdx	parent,
		const std::list< UIdx > &	listChildren )

Connect a parent to its children.

Parameters

parent	: index of the parent Node
listChildren	: list of the children index

Definition at line 282 of file Graph_impl.h.

                                                                               {
        Node<T, UIdx> * parentNode = getNode(parent);
        if(parentNode == NULL){return;}
        for(typename std::list<UIdx>::const_iterator it(listChildren.begin()); it != listChildren.end(); ++it){
                UIdx child = *it;
                Node<T, UIdx> * childNode = getNode(child);
                if(childNode == NULL){continue;}
                parentNode->addChild(child);
                childNode->addParent(parent);
        }
}

References Node< T, UIdx >::addChild(), Node< T, UIdx >::addParent(), and getNode().

Here is the call graph for this function:

◆ connectNode() [2/3]

template<typename T, typename UIdx>

void Graph< T, UIdx >::connectNode	(	UIdx	parent,
		const std::vector< UIdx > &	vecChildren )

Connect a parent to its children.

Parameters

parent	: index of the parent Node
vecChildren	: vector of the children index

Definition at line 299 of file Graph_impl.h.

                                                                                {
        Node<T, UIdx> * parentNode = getNode(parent);
        if(parentNode == NULL){return;}
        for(typename std::vector<UIdx>::const_iterator it(vecChildren.begin()); it != vecChildren.end(); ++it){
                UIdx child = *it;
                Node<T, UIdx> * childNode = getNode(child);
                if(childNode == NULL){continue;}
                parentNode->addChild(child);
                childNode->addParent(parent);
        }
}

References Node< T, UIdx >::addChild(), Node< T, UIdx >::addParent(), and getNode().

Here is the call graph for this function:

◆ connectNode() [3/3]

template<typename T, typename UIdx>

void Graph< T, UIdx >::connectNode	(	UIdx	parent,
		UIdx	child )

Connect a parent to its child.

Parameters

parent	: index of the parent Node
child	: index of the child Node

Definition at line 268 of file Graph_impl.h.

                                                       {
        Node<T, UIdx> * parentNode = getNode(parent);
        if(parentNode == NULL){return;}
        Node<T, UIdx> * childNode = getNode(child);
        if(childNode == NULL){return;}
        parentNode->addChild(child);
        childNode->addParent(parent);
}

References Node< T, UIdx >::addChild(), Node< T, UIdx >::addParent(), and getNode().

Referenced by removeNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyGraph()

template<typename T, typename UIdx>

void Graph< T, UIdx >::copyGraph ( const Graph< T, UIdx > & other )

protected

Copy function of Graph.

Parameters

other : class to copy

Definition at line 553 of file Graph_impl.h.

                                                          {
        p_mapNode = other.p_mapNode;
        p_listFirstNode = other.p_listFirstNode;
        p_listLastNode = other.p_listLastNode;
}

References Graph(), p_listFirstNode, p_listLastNode, and p_mapNode.

Referenced by Graph(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createNode() [1/2]

template<typename T, typename UIdx>

UIdx Graph< T, UIdx >::createNode	(	const T &	data,
		const std::string &	name )

Create a node and get its index.

Parameters

data	: data of the Node
name	: name of the Node

Returns: index of the Node

Definition at line 123 of file Graph_impl.h.

                                                                     {
        UIdx nodeIndex(p_mapNode.size());
        while(getNode(nodeIndex) != NULL){
                ++nodeIndex;
        }
        Node<T, UIdx> node(data, name);
        node.setIndex(nodeIndex);
        p_mapNode[nodeIndex] = node;
        return nodeIndex;
}

References getNode(), p_mapNode, and Node< T, UIdx >::setIndex().

Referenced by createNodePtr(), and createNodePtr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createNode() [2/2]

template<typename T, typename UIdx>

bool Graph< T, UIdx >::createNode	(	const T &	data,
		const UIdx &	index,
		const std::string &	name )

Create a node and get its index.

Parameters

data	: data of the Node
index	: index of the Node
name	: name of the Node

Returns: true if the node can be created, false if the index is already taken by an other Node

Definition at line 152 of file Graph_impl.h.

                                                                                         {
        if(getNode(index) != NULL){     //Check if the Node already exists
                return false;
        }
        Node<T, UIdx> node(data, name);
        node.setIndex(index);
        p_mapNode[index] = node;
        return true;
}

References getNode(), p_mapNode, and Node< T, UIdx >::setIndex().

Here is the call graph for this function:

◆ createNodePtr() [1/2]

template<typename T, typename UIdx>

Node< T, UIdx > * Graph< T, UIdx >::createNodePtr	(	const T &	data,
		const std::string &	name )

Create a node and get its pointer.

Parameters

data	: data of the Node
name	: name of the Node

Returns: pointer of the Node

Definition at line 140 of file Graph_impl.h.

                                                                                   {
        UIdx node = createNode(data, name);
        return getNode(node);
}

References createNode(), and getNode().

Here is the call graph for this function:

◆ createNodePtr() [2/2]

template<typename T, typename UIdx>

Node< T, UIdx > * Graph< T, UIdx >::createNodePtr	(	const T &	data,
		const UIdx &	index,
		const std::string &	name )

Create a node and get its pointer.

Parameters

data	: data of the Node
index	: index of the Node
name	: name of the Node

Returns: pointer of the Node

Definition at line 169 of file Graph_impl.h.

                                                                                                       {
        if(createNode(data, index, name)){
                return getNode(index);
        }else{
                return NULL;
        }
}

References createNode(), and getNode().

Here is the call graph for this function:

◆ getFirstNotUpdatedNode() [1/2]

template<typename T, typename UIdx>

Node< T, UIdx > * Graph< T, UIdx >::getFirstNotUpdatedNode ( )

Get the first node which is not udpated (getIsUpdated() == false)

Returns: pointer to the first node which is not udpated or NULL if there is no

Definition at line 356 of file Graph_impl.h.

                                                      {
        for(typename std::map<UIdx, Node<T, UIdx> >::iterator itNode(p_mapNode.begin()); itNode != p_mapNode.end(); ++itNode){
                if(!itNode->second.getIsUpdated()){
                        return &(itNode->second);
                }
        }
        return NULL;
}

References p_mapNode.

◆ getFirstNotUpdatedNode() [2/2]

template<typename T, typename UIdx>

const Node< T, UIdx > * Graph< T, UIdx >::getFirstNotUpdatedNode ( ) const

Get the first node which is not udpated (getIsUpdated() == false)

Returns: pointer to the first node which is not udpated or NULL if there is no

Definition at line 343 of file Graph_impl.h.

                                                                  {
        for(typename std::map<UIdx, Node<T, UIdx> >::const_iterator itNode(p_mapNode.begin()); itNode != p_mapNode.end(); ++itNode){
                if(!itNode->second.getIsUpdated()){
                        return &(itNode->second);
                }
        }
        return NULL;
}

References p_mapNode.

◆ getListFirstNode()

template<typename T, typename UIdx>

const std::list< UIdx > & Graph< T, UIdx >::getListFirstNode ( ) const

Get the list of the first nodes (without parent)

Returns: list of the first nodes (without parent)

Definition at line 387 of file Graph_impl.h.

                                                            {
        return p_listFirstNode;
}

References p_listFirstNode.

Referenced by iterateChildren(), and iterateChildrenCheckUpdate().

Here is the caller graph for this function:

◆ getListLastNode()

template<typename T, typename UIdx>

const std::list< UIdx > & Graph< T, UIdx >::getListLastNode ( ) const

Get the list of the last nodes (without child)

Returns: list of the last nodes (without child)

Definition at line 395 of file Graph_impl.h.

                                                           {
        return p_listLastNode;
}

References p_listLastNode.

Referenced by iterateParent(), and iterateParentCheckUpdate().

Here is the caller graph for this function:

◆ getNode() [1/2]

template<typename T, typename UIdx>

Node< T, UIdx > * Graph< T, UIdx >::getNode ( UIdx index )

Get a Node by pointer.

Parameters

index : index of the node to be used

Returns: pointer to this Node or NULL if the Node does not exist

Definition at line 330 of file Graph_impl.h.

                                                 {
        typename std::map<UIdx, Node<T, UIdx> >::iterator it(p_mapNode.find(index));
        if(it != p_mapNode.end()){
                return &(it->second);
        }else{
                return NULL;
        }
}

References p_mapNode.

◆ getNode() [2/2]

template<typename T, typename UIdx>

const Node< T, UIdx > * Graph< T, UIdx >::getNode ( UIdx index ) const

Get a Node by pointer.

Parameters

index : index of the node to be used

Returns: pointer to this Node or NULL if the Node does not exist

Definition at line 316 of file Graph_impl.h.

                                                             {
        typename std::map<UIdx, Node<T, UIdx> >::const_iterator it(p_mapNode.find(index));
        if(it != p_mapNode.end()){
                return &(it->second);
        }else{
                return NULL;
        }
}

References p_mapNode.

Referenced by connectNode(), connectNode(), connectNode(), createNode(), createNode(), createNodePtr(), createNodePtr(), isListNodeUdpated(), iterateChildren(), iterateChildrenCheckUpdate(), iterateParent(), iterateParentCheckUpdate(), removeNode(), and toDot().

Here is the caller graph for this function:

◆ initialisationGraph()

template<typename T, typename UIdx>

void Graph< T, UIdx >::initialisationGraph ( )

private

Initialisation function of the class Graph.

Definition at line 561 of file Graph_impl.h.

                                        {
        
}

Referenced by Graph().

Here is the caller graph for this function:

◆ isListNodeUdpated()

template<typename T, typename UIdx>

bool Graph< T, UIdx >::isListNodeUdpated ( const std::list< UIdx > & listNode ) const

Check if the list of given nodes are all updated or not.

Parameters

listNode : list of nodes to be checked

Returns: true fi all nodes are updated, false otherwise

Definition at line 460 of file Graph_impl.h.

                                                                          {
        bool b(true);
        for(typename std::list<UIdx>::const_iterator itNode(listNode.begin()); itNode != listNode.end() && b; ++itNode){
                const Node<T, UIdx> * node = getNode(*itNode);
                if(node != NULL){
                        b &= node->getIsUpdated();
                }
        }
        return b;
}

References Node< T, UIdx >::getIsUpdated(), and getNode().

Referenced by iterateChildrenCheckUpdate(), and iterateParentCheckUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isNodeExist()

template<typename T, typename UIdx>

bool Graph< T, UIdx >::isNodeExist ( UIdx index ) const

Say if the node at index does exit.

Parameters

index : index of the node to be searched

Returns: true if the Node does exist, false otheriwse

Definition at line 370 of file Graph_impl.h.

                                                {
        typename std::map<UIdx, Node<T, UIdx> >::iterator it(p_mapNode.find(index));
        return it != p_mapNode.end();
}

References p_mapNode.

◆ iterateChildren()

template<typename T, typename UIdx>

bool Graph< T, UIdx >::iterateChildren ( std::list< UIdx > & listNode ) const

Iterate from parents to chidren.

Parameters

[out] listNode : list node which can be treated simultaneously

Returns: true if the returned list of nodes is not empty, false if the bottom of the Graph has been reached

Definition at line 404 of file Graph_impl.h.

                                                                  {
        if(listNode.size() == 0lu){
                listNode = getListFirstNode();
        }else{
                std::map<UIdx, bool> mapListChildren;
                for(typename std::list<UIdx>::iterator itNode(listNode.begin()); itNode != listNode.end(); ++itNode){
                        const Node<T, UIdx> * node = getNode(*itNode);
                        if(node != NULL){
                                const std::list<UIdx> & listChildren = node->getListChild();
                                for(typename std::list<UIdx>::const_iterator it(listChildren.begin()); it != listChildren.end(); ++it){
                                        mapListChildren[*it] = true;
                                }
                        }
                }
                std::list<UIdx> listNodeOut;
                for(typename std::map<UIdx, bool>::iterator it(mapListChildren.begin()); it != mapListChildren.end(); ++it){
                        listNodeOut.push_back(it->first);
                }
                listNode = listNodeOut;
        }
        return listNode.size() != 0lu;
}

References Node< T, UIdx >::getListChild(), getListFirstNode(), and getNode().

Here is the call graph for this function:

◆ iterateChildrenCheckUpdate()

template<typename T, typename UIdx>

bool Graph< T, UIdx >::iterateChildrenCheckUpdate ( std::list< UIdx > & listNode )

Iterate from parents to chidren (all node are iterated only once)

Parameters

[out] listNode : list node which can be treated simultaneously

Returns: true if the returned list of nodes is not empty, false if the bottom of the Graph has been reached

Definition at line 476 of file Graph_impl.h.

                                                                       {
        if(listNode.size() == 0lu){
                clearIsUpdated();
                listNode = getListFirstNode();
        }else{
                std::map<UIdx, bool> mapListChildren;
                for(typename std::list<UIdx>::iterator itNode(listNode.begin()); itNode != listNode.end(); ++itNode){
                        Node<T, UIdx> * node = getNode(*itNode);
                        if(node != NULL){
                                node->setIsUpdated(true);   //This node has been iterated, so we do not want to pick it as a child
                                std::list<UIdx> & listChildren = node->getListChild();
                                for(typename std::list<UIdx>::iterator it(listChildren.begin()); it != listChildren.end(); ++it){
                                        Node<T, UIdx> * nodeChild = getNode(*it);
                                        if(nodeChild != NULL){
                                                if(!nodeChild->getIsUpdated()){
                                                        //The child node is added only if its parents are updated
                                                        if(isListNodeUdpated(nodeChild->getListParent())){
                                                                mapListChildren[*it] = true;
                                                                nodeChild->setIsUpdated(true);
                                                        }
                                                }
                                        }
                                }
                        }
                }
                std::list<UIdx> listNodeOut;
                for(typename std::map<UIdx, bool>::iterator it(mapListChildren.begin()); it != mapListChildren.end(); ++it){
                        listNodeOut.push_back(it->first);
                }
                listNode = listNodeOut;
        }
        return listNode.size() != 0lu;
}

References clearIsUpdated(), Node< T, UIdx >::getIsUpdated(), Node< T, UIdx >::getListChild(), getListFirstNode(), Node< T, UIdx >::getListParent(), getNode(), isListNodeUdpated(), and Node< T, UIdx >::setIsUpdated().

Here is the call graph for this function:

◆ iterateParent()

template<typename T, typename UIdx>

bool Graph< T, UIdx >::iterateParent ( std::list< UIdx > & listNode ) const

Iterate from children to parents.

Parameters

[out] listNode : list node which can be treated simultaneously

Returns: true if the returned list of nodes is not empty, false if the top of the Graph has been reached

Definition at line 432 of file Graph_impl.h.

                                                                {
        if(listNode.size() == 0lu){
                listNode = getListLastNode();
        }else{
                std::map<UIdx, bool> mapListParent;
                for(typename std::list<UIdx>::iterator itNode(listNode.begin()); itNode != listNode.end(); ++itNode){
                        const Node<T, UIdx> * node = getNode(*itNode);
                        if(node != NULL){
                                const std::list<UIdx> & listParent = node->getListParent();
                                for(typename std::list<UIdx>::const_iterator it(listParent.begin()); it != listParent.end(); ++it){
                                        mapListParent[*it] = true;
                                }
                        }
                }
                std::list<UIdx> listNodeOut;
                for(typename std::map<UIdx, bool>::iterator it(mapListParent.begin()); it != mapListParent.end(); ++it){
                        listNodeOut.push_back(it->first);
                }
                listNode = listNodeOut;
        }
        return listNode.size() != 0lu;
}

References getListLastNode(), Node< T, UIdx >::getListParent(), and getNode().

Here is the call graph for this function:

◆ iterateParentCheckUpdate()

template<typename T, typename UIdx>

bool Graph< T, UIdx >::iterateParentCheckUpdate ( std::list< UIdx > & listNode )

Iterate from children to parents (all node are iterated only once)

Parameters

[out] listNode : list node which can be treated simultaneously

Returns: true if the returned list of nodes is not empty, false if the top of the Graph has been reached

Definition at line 515 of file Graph_impl.h.

                                                                     {
        if(listNode.size() == 0lu){
                clearIsUpdated();
                listNode = getListLastNode();
        }else{
                std::map<UIdx, bool> mapListParent;
                for(typename std::list<UIdx>::iterator itNode(listNode.begin()); itNode != listNode.end(); ++itNode){
                        Node<T, UIdx> * node = getNode(*itNode);
                        if(node != NULL){
                                node->setIsUpdated(true);   //This node has been iterated, so we do not want to pick it as a parent
                                std::list<UIdx> & listParent = node->getListParent();
                                for(typename std::list<UIdx>::iterator it(listParent.begin()); it != listParent.end(); ++it){
                                        Node<T, UIdx> * nodeParent = getNode(*it);
                                        if(nodeParent != NULL){
                                                if(!nodeParent->getIsUpdated()){
                                                        //The parent node is added only if its children are updated
                                                        if(isListNodeUdpated(nodeParent->getListChild())){
                                                                mapListParent[*it] = true;
                                                                nodeParent->setIsUpdated(true);
                                                        }
                                                }
                                        }
                                }
                        }
                }
                std::list<UIdx> listNodeOut;
                for(typename std::map<UIdx, bool>::iterator it(mapListParent.begin()); it != mapListParent.end(); ++it){
                        listNodeOut.push_back(it->first);
                }
                listNode = listNodeOut;
        }
        return listNode.size() != 0lu;
}

References clearIsUpdated(), Node< T, UIdx >::getIsUpdated(), Node< T, UIdx >::getListChild(), getListLastNode(), Node< T, UIdx >::getListParent(), getNode(), isListNodeUdpated(), and Node< T, UIdx >::setIsUpdated().

Here is the call graph for this function:

◆ operator=()

template<typename T, typename UIdx>

Graph< T, UIdx > & Graph< T, UIdx >::operator= ( const Graph< T, UIdx > & other )

Definition of equal operator of Graph.

Parameters

other : class to copy

Returns: copied class

Definition at line 40 of file Graph_impl.h.

                                                                        {
        copyGraph(other);
        return *this;
}

References copyGraph(), and Graph().

Here is the call graph for this function:

◆ removeNode()

template<typename T, typename UIdx>

void Graph< T, UIdx >::removeNode	(	UIdx	index,
		bool	reconnectParentToChildren = false )

Remove a Node from the Graph.

Parameters

index	: index of the Node to be removed
reconnectParentToChildren	: true to reconnect parents of the node to be removed to its children

Definition at line 210 of file Graph_impl.h.

                                                                         {
        Node<T, UIdx> * indexNode = getNode(index);
        if(indexNode == NULL){return;}     //If the Node does not exist, we stop
        //Get the parents of the current Node
        std::list<UIdx> & listParent = indexNode->getListParent();
        if(listParent.size() != 0lu){
                //Tell them they do not have child anymore
                for(typename std::list<UIdx>::iterator it(listParent.begin()); it != listParent.end(); ++it){
                        Node<T, UIdx> * parentNode = getNode(*it);
                        if(parentNode == NULL){continue;}
                        parentNode->removeChild(index);
                }
        }else{
                //Let's remove the current Node from first Node
                listindex_remove(p_listFirstNode, index);
        }
        //Get the children of the current Node
        std::list<UIdx> & listChild = indexNode->getListChild();
        if(listChild.size() != 0lu){
                //Tell them they do not have parent anymore
                for(typename std::list<UIdx>::iterator it(listChild.begin()); it != listChild.end(); ++it){
                        Node<T, UIdx> * childNode = getNode(*it);
                        if(childNode == NULL){continue;}
                        childNode->removeParent(index);
                }
        }else{
                //Let's remove the current Node from last Node
                listindex_remove(p_listLastNode, index);
        }
        if(reconnectParentToChildren && listParent.size() != 0lu && listChild.size() != 0lu){
                for(typename std::list<UIdx>::iterator it(listParent.begin()); it != listParent.end(); ++it){
                        connectNode(*it, listChild);
                }
        }
        //Now, let's remove the current Node
        p_mapNode.erase(index);
}

References connectNode(), Node< T, UIdx >::getListChild(), Node< T, UIdx >::getListParent(), getNode(), listindex_remove(), p_listFirstNode, p_listLastNode, p_mapNode, Node< T, UIdx >::removeChild(), and Node< T, UIdx >::removeParent().

Here is the call graph for this function:

◆ saveDot() [1/2]

template<typename T, typename UIdx>

bool Graph< T, UIdx >::saveDot ( const std::string & fileName ) const

Save the Graph in a dot file.

Parameters

fileName : name of the file to be created

Definition at line 69 of file Graph_impl.h.

                                                            {
        if(fileName == ""){return false;}
        std::ofstream fs;
        fs.open(fileName.c_str());
        if(!fs.is_open()){
                std::cerr << "Graph<T, UIdx>::saveDot : can't open file '" << fileName << "'" << std::endl;
                return false;
        }
        bool b(saveDot(fs));
        fs.close();
        return b;
}

References saveDot().

Referenced by saveDot(), and savePng().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveDot() [2/2]

template<typename T, typename UIdx>

bool Graph< T, UIdx >::saveDot ( std::ofstream & fs ) const

Save the Graph in a dot file.

Parameters

[out] fs : file stream to be modified

Definition at line 86 of file Graph_impl.h.

                                                  {
        fs << toDot();
        return true;
}

References toDot().

Here is the call graph for this function:

◆ savePng()

template<typename T, typename UIdx>

bool Graph< T, UIdx >::savePng ( const std::string & fileNamePng ) const

Save a png file of the graph.

Parameters

fileNamePng : name of the png file

Returns: true on success, false otherwise

Definition at line 50 of file Graph_impl.h.

                                                               {
        if(fileNamePng == "") return false;
        std::string fileTxt("output.dot");
        if(!saveDot(fileTxt)){
                std::cerr << "Graph<T, UIdx>::savePng : can't create file '" << fileTxt << "'" << std::endl;
                return false;
        }
        std::string commande("dot -Tpng -o " + fileNamePng + " " + fileTxt + " && rm " + fileTxt);
        if(system(commande.c_str()) != 0){
                std::cerr << "Graph<T, UIdx>::savePng : can't create png file '" << fileNamePng << "'" << std::endl;
                return false;
        }
        return true;
}

References saveDot().

Here is the call graph for this function:

◆ size()

template<typename T, typename UIdx>

size_t Graph< T, UIdx >::size ( ) const

Get the number of nodes inside the graph.

Returns: number of nodes inside the graph

Definition at line 379 of file Graph_impl.h.

                                 {
        return p_mapNode.size();
}

References p_mapNode.

◆ toDot()

template<typename T, typename UIdx>

std::string Graph< T, UIdx >::toDot ( ) const

Convert the graph to dot language.

Returns: dot

Definition at line 95 of file Graph_impl.h.

                                     {
        std::string body("");
        body += "digraph G{\n";
        //save the node definition
        for(typename std::map<UIdx, Node<T, UIdx> >::const_iterator it(p_mapNode.begin()); it != p_mapNode.end(); ++it){
                body += it->second.getDotDefinition();
        }
        //save the connections between nodes
        for(typename std::map<UIdx, Node<T, UIdx> >::const_iterator itNode(p_mapNode.begin()); itNode != p_mapNode.end(); ++itNode){
                const std::string & parentNodeName(itNode->second.getDotName());
                const std::list<UIdx> & listChild = itNode->second.getListChild();
                for(typename std::list<UIdx>::const_iterator it(listChild.begin()); it != listChild.end(); ++it){
                        const Node<T, UIdx> * childNode = getNode(*it);
                        if(childNode == NULL){continue;}
                        const std::string & childNodeName(childNode->getDotName());
                        body += "\t" + parentNodeName + " -> " + childNodeName + "[color=\"red\"];\n";
                }
        }
        body += "}\n\n";
        return body;
}

References Node< T, UIdx >::getDotName(), getNode(), and p_mapNode.

Referenced by saveDot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateFirstLastNode()

template<typename T, typename UIdx>

void Graph< T, UIdx >::updateFirstLastNode ( )

Update the first and last Node of the Graph.

Definition at line 250 of file Graph_impl.h.

                                        {
        clearFirstNode();
        clearLastNode();
        for(typename std::map<UIdx, Node<T, UIdx> >::iterator itNode(p_mapNode.begin()); itNode != p_mapNode.end(); ++itNode){
                if(itNode->second.isStart()){     //If the Node does not have any parent, it is a first Node
                        p_listFirstNode.push_back(itNode->first);
                }
                if(itNode->second.isEnd()){       //If the Node does not have any child, it is a last Node
                        p_listLastNode.push_back(itNode->first);
                }
        }
}

References clearFirstNode(), clearLastNode(), p_listFirstNode, p_listLastNode, and p_mapNode.

Here is the call graph for this function:

Member Data Documentation

◆ p_listFirstNode

template<typename T, typename UIdx>

std::list<UIdx> Graph< T, UIdx >::p_listFirstNode

private

List of the first Node (without parent)

Definition at line 80 of file Graph.h.

Referenced by clearFirstNode(), copyGraph(), getListFirstNode(), removeNode(), and updateFirstLastNode().

◆ p_listLastNode

template<typename T, typename UIdx>

std::list<UIdx> Graph< T, UIdx >::p_listLastNode

private

List of the last Node (without child)

Definition at line 82 of file Graph.h.

Referenced by clearLastNode(), copyGraph(), getListLastNode(), removeNode(), and updateFirstLastNode().

◆ p_mapNode

template<typename T, typename UIdx>

std::map<UIdx, Node<T, UIdx> > Graph< T, UIdx >::p_mapNode

private

Map of the Node.

Definition at line 78 of file Graph.h.

Referenced by clearIsUpdated(), clearMapNode(), copyGraph(), createNode(), createNode(), getFirstNotUpdatedNode(), getFirstNotUpdatedNode(), getNode(), getNode(), isNodeExist(), removeNode(), size(), toDot(), and updateFirstLastNode().

The documentation for this class was generated from the following files:

/builds/CTA-LAPP/PHOENIX_LIBS2/graph/PhoenixGraph/src/Graph.h
/builds/CTA-LAPP/PHOENIX_LIBS2/graph/PhoenixGraph/src/Graph_impl.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Graph() [1/2]

◆ Graph() [2/2]

◆ ~Graph()

Member Function Documentation

◆ clearAll()

◆ clearFirstNode()

◆ clearIsUpdated()

◆ clearLastNode()

◆ clearMapNode()

◆ connectNode() [1/3]

◆ connectNode() [2/3]

◆ connectNode() [3/3]

◆ copyGraph()

◆ createNode() [1/2]

◆ createNode() [2/2]

◆ createNodePtr() [1/2]

◆ createNodePtr() [2/2]

◆ getFirstNotUpdatedNode() [1/2]

◆ getFirstNotUpdatedNode() [2/2]

◆ getListFirstNode()

◆ getListLastNode()

◆ getNode() [1/2]

◆ getNode() [2/2]

◆ initialisationGraph()

◆ isListNodeUdpated()

◆ isNodeExist()

◆ iterateChildren()

◆ iterateChildrenCheckUpdate()

◆ iterateParent()

◆ iterateParentCheckUpdate()

◆ operator=()

◆ removeNode()

◆ saveDot() [1/2]

◆ saveDot() [2/2]

◆ savePng()

◆ size()

◆ toDot()

◆ updateFirstLastNode()

Member Data Documentation

◆ p_listFirstNode

◆ p_listLastNode

◆ p_mapNode