[[http://www.boost.org/doc/libs/1_60_0/libs/graph/doc/index.html|Boost Graph Library]] (BGL) est une bibliothèque permettant de créer et manipuler des graphes. Ce tutoriel est une introduction pratique à //BGL// permettant de prendre en main facilement les fonctionnalités de base. ====== Commencer facilement avec Boost Graph ====== ===== Que propose Boost Graph ? ===== //Boost Graph// propose une interface standard pour manipuler des graphes. Cette interface est similaire aux conteneurs de la bibliothèque standard et permet l'accès aux différents éléments à l'aide d'itérateurs. Il est donc possible d'utiliser les algorithmes de la bibliothèque standard pour travailler sur les graphes ou d'utiliser les algorithmes spécifiques pour les graphes fournis par //Boost Graph//. On peut aussi manipuler les éléments du graphe, accessibles via la classe de traits : les sommets (ou nœuds, ''vertex'' dans //BGL//), les arcs (pour un graphe orienté ou arêtes pour un graphe non orienté, ''edge'' dans //BGL//) et le graphe lui-même (''graph'' dans //BGL//) {{ :boost-graph-1.png |}} ^ Figure 1: Exemple de graphe avec 5 sommets (v1 à v5) et 7 arcs (e1 à e7) qui sera utilisé tout au long de ce tutoriel ^ ===== Comment débuter avec Boost Graph ? ===== ==== Créer un graphe générique ==== Boost Graph propose de nombreux outils qui nécessite un certain temps pour tout appréhender. Cependant, il est possible d'utiliser la classe ''adjacent_list'' comme boîte à outils généraliste.


#include

Les informations relatives à chaque élément d'un graphe sont enregistrées dans des structures :


struct VertexProperties { ... };
struct EdgeProperties { ... };
struct GraphProperties { ... };

On peut alors créer un graphe générique basé sur ''adjacent_list''. Pour des raisons pratiques, il est préférable de créer un [[http://guillaume.belz.free.fr/doku.php?id=definir_ses_types#alias_de_type|alias de type]] sur cette structure puisqu'elle sera réutilisée plusieurs fois :


using Graph = boost::adjacency_list<
   boost::vecS, boost::vecS, boost::bidirectionalS,
   boost::property,
   boost::property,
   boost::property
>;


Graph  g;

==== Comment manipuler les sommets ? ==== Le type correspondant à la description d'un sommet est accessible via la classe de traits ''graph_traits'' :


using vertex_t = boost::graph_traits::vertex_descriptor;

La fonction ''add_vertex'' permet d'ajouter un sommet dans un graphe. Les informations attachées au sommet peuvent être spécifiées lors de la création :


struct VertexProperties 
{ 
   std::string name;
   unsigned id;
   VertexProperties() : name(""), id(0) {}
   VertexProperties(std::string const& n, unsigned i) : name(n), id(i) {}
};


vertex_t v1 = boost::add_vertex(g);


vertex_t v2 = boost::add_vertex(VertexProperties("toto", 12), g);

L'opérateur ''[]'' permet de récupérer les informations d'un sommet. Il retourne une référence, ce qui permet de pouvoir modifier les informations :


VertexProperties const& vertexProperties = g[v1];
std::cout << "Vertex name : " <<  vertexProperties.name << std::endl;


VertexProperties& vertexProperties = g[v2];
v2.id = 17;

La fonction ''num_vertices'' permet de connaître le nombre de sommets dans un graphe :


boost::graph_traits::vertices_size_type s = num_vertices(g);

==== Comment manipuler les arcs ? ==== Le type correspondant à la description d'un arc est accessible via la classe de traits ''graph_traits'' :


using edge_t = boost::graph_traits::edge_descriptor;

La fonction ''add_edge'' permet de connecter deux sommets. Les informations attachées à l'arc peuvent être spécifiées lors de la création :


struct EdgeProperties 
{ 
   float weight;
   float distance;
   EdgeProperties() : weight(0.0), distance(0.0) {}
   EdgeProperties(float w, float d) : weight(w), distance(d) {}
};


std::pair e1 = boost::add_edge(v1, v2, g);


std::pair e2 = 
   boost::add_edge(v1, v2, EdgeProperties(1.0, 50.0), g);

L'opérateur ''[]'' permet de récupérer les informations d'un arc. Il retourne une référence, ce qui permet de pouvoir modifier les informations :


EdgeProperties const& edgeProperties = g[e1];
std::cout << "Edge weight : " <<  edgeProperties. weight << std::endl;


EdgeProperties& edgeProperties = g[e2];
e2. distance = 103.8;

La fonction ''num_edges'' permet de connaître le nombre d'arcs dans un graphe :


boost::graph_traits::edges_size_type s = num_edges(g);

Il est possible de récupérer les descripteurs des sommets associés à un arc à l'aide des fonctions ''source'' et ''target'' :


Graph::target_descriptor v1 = boost::target(e1, g);
Graph::target_descriptor v2 = boost::source(e5, g);
if (v1 == v2)
   std::cout << "Same vertex" << std::endl;

==== Comment supprimer des sommets et des arcs ? ==== Boost Graph fournit plusieurs fonctions pour supprimer des éléments d'un graphe. Attention, ces fonctions invalident les itérateurs existants.


clear(g);


clear_in_edges(v1, g);
clear_out_edges(v2, g);


clear_vertex(v1, g);


remove_edge(v1, v2, g);
remove_edge(e3, g);


// il est nécessaire de supprimer les arcs liés à un sommet...
clear_vertex(v1, g);
// ... avant de le supprimer
remove_vertex(v1, g);

==== Comment utiliser des algorithmes ? ==== Boost Graph fournit des fonctions pour récupérer des itérateurs sur les sommets ou les arcs d'un graphe. Il est ensuite possible de les utiliser directement dans les algorithmes de la bibliothèque standard.


std::pair it = boost::vertices(g);


std::pair it = boost::edges(g);


std::pair it = boost::out_edges(v1, g);


std::pair it = boost::in_edges(v1, g);


std::pair it =
    boost::adjacent_vertices(v1, g);

On peut alors parcourir tous les éléments sélectionnés. Par exemple, pour afficher le nom de tous les sommets :


std::pair it = boost::vertices(g);
for( ; it.first != it.second; ++it.first)
   std::cout << get(boost::vertex_bundle, g)[*it.first].name << std::endl;

==== Quels sont les algorithmes proposés par Boost Graph ? ==== * Breadth First Search * Connected Components * Depth First Search * Strongly Connected Components * Uniform Cost Search * Dynamic Connected Components * Dijkstra's Shortest Paths * Topological Sort * Bellman-Ford Shortest Paths * Transpose * Johnson's All-Pairs Shortest Paths * Reverse Cuthill Mckee Ordering * Kruskal's Minimum Spanning Tree * Smallest Last Vertex Ordering * Prim's Minimum Spanning Tree * Sequential Vertex Coloring Voir la documentation de Boost Graph pour l'utilisation de ces algorithmes. ===== Aller un peu plus loin avec Boost Graph ===== ==== Utiliser la fonction tie ==== La fonction ''tie'' de ''boost/tuple/tuple.hpp'' (et maintenant dans ''std'' avec le C++11) permet de récupérer une ''std::pair'' directement dans deux variables :


Graph::edge_descriptor e1;
bool succes;
tie(e1, succes) = boost::add_edge(v1, v2, g);
if (succes)
   // using edge e1

==== Que signifient les paramètres passés à adjacent_list ? ==== adjacency_list est une classe template acceptant plusieurs paramètres permettant de spécifier le comportement de cette classe. Ces paramètres permettent de choisir les types de conteneurs utilisés en interne (''OutEdgeList'', ''VertexList'' et ''EdgeList''), les propriétés associées aux éléments du graphe (''VertexProperties'', ''EdgeProperties'', ''GraphProperties'' et ''Directed''). Voici la liste des paramètres et les valeurs par défaut de ''adjacency_list'' :


adjacency_list<
   OutEdgeList 		= vecS, 
   VertexList 		= vecS, 
   Directed		= directedS,
   VertexProperties	= no_property,  
   EdgeProperties 	= no_property,
   GraphProperties 	= no_property, 
   EdgeList		= listS
>

==== Les types des conteneurs ==== Les types de conteneurs (''OutEdgeList'', ''VertexList'' et ''EdgeList'') peuvent être choisir en utilisant les tags précisés dans la liste suivante :


vecS		= std::vector
listS		= std::list
slistS		= std::slist
setS		= std::set
multisetS	= std::multiset
hash_setS	= std::hash_set

Le choix du type de conteneur aura une influence sur les performances des algorithmes utilisés. La complexité des fonctions de Boost Graph en fonction du type de conteneur est indiqué dans la page suivante : [[http://www.boost.org/doc/libs/1_60_0/libs/graph/doc/using_adjacency_list.html#sec:choosing-graph-type|using_adjacency_list]]. ==== L'orientation des arcs ==== Le paramètre Directed permet de préciser si le graphe est orienté ou non et si les arcs seront unidirectionnels ou bidirectionnels.


undirectedS		= graphe non orienté
directedS		= graphe orienté avec des arcs unidirectionnels
bidirectionalS		= graphe orienté avec des arcs bidirectionnels

En fonction du type de graphe, certaines fonctions ne seront pas disponibles. Par exemple, avec un graphe orienté unidirectionnel, la fonction in_edges, permettant de récupérer la liste des arcs entrant, n'est pas utilisable. De même, certains algorithmes ne seront possibles que pour certains types de graphes. {{ :boost-graph-2.png |}} ^ Figure 2 : Différents types de graphes ^ ''directedS'' ne permet pas de récupérer les arcs entrants dans un sommet (''in_edges'') d'où l'existence de ''bidirectionalS''. Tous deux sont des graphes orientés au niveau conceptuel. Par défaut, on choisit entre ''undirectedS'' ou ''birectionalS'' en fonction de la nature du graphe (non orienté / orienté). ''directedS'' sera une optimisation possible pour consommer moins de mémoire. ==== Les propriétés associées ==== Pour les propriétés associées aux éléments d'un graphe, on peut soit utiliser le mot clé ''no_property'' pour ne pas associer d'informations, soit utiliser la méthode décrite dans les chapitre 3-B pour les sommets et 3-C pour les arcs, soit utiliser une des méthodes décrites ensuite. Il existe deux approches possible pour enregistrer les informations dans un graphe : utiliser des conteneurs externes ("external property storage") ou directement dans un graphe ("internal properties"). === Enregistrer les informations dans des conteneurs externes === == Créer une property_map == Il existe plusieurs classes dans ''property_map'' mais nous allons décrire uniquement ''associative_property_map'' ici. Une ''property_map'' prend en paramètre un conteneur associatif. Nous utilisons pour //Boost Graph// un descripteur de sommets ou d'arcs comme clé :


using names_property_t = std::map;
names_property_t names;
boost::associative_property_map names_map(names);
 
using weights_property_t = std::map;
weights_property_t weights;
boost::associative_property_map weights_map(weights);

== Accéder aux informations == Pour accéder aux données, on utilise les fonctions ''put'', ''get'' et l'opérateur ''[]'' :


std::string v1_name = get(names_map, v1) ;
put(names_map, v2, "toto");


std::string v1_name = names_map[v1];
names_map[v2] = "toto";

=== Enregistrer les informations directement dans le graphe === Il est possible d'utiliser les paramètres template ''VertexProperties'', ''EdgeProperties'' et ''GraphProperties'' de adjacent_list pour enregistrer des informations directement dans le graphe. Chaque information est identifiée par un tag, auquel on spécifie un type de données et une valeur. Par exemple, on peut associer un nom à chaque sommet :


// using
using VertexProperties = boost::property;
 
// création d'un sommet
vertex_t v1 = boost::add_vertex("toto", g);
 
// récupérer le nom
std::cout << "Vertex name : " <<  g[v1] << std::endl;
 
// modifier le nom
v1 = "titi";

== Les tags pré-définis == Il existe un certain nombre de tags pré-définis : * vertex_index_t * edge_residual_capacity_t * vertex_isomorphism_t * vertex_index1_t * edge_reverse_t * vertex_invariant_t * vertex_index2_t * vertex_distance_t * vertex_invariant1_t * edge_index_t * vertex_root_t * vertex_invariant2_t * graph_name_t * vertex_all_t * vertex_degree_t * vertex_name_t * edge_all_t * vertex_out_degree_t * edge_name_t * graph_all_t * vertex_in_degree_t * edge_weight_t * vertex_color_t * vertex_discover_time_t * edge_weight2_t * vertex_rank_t * vertex_finish_time_t * edge_capacity_t * vertex_predecessor_t == Créer ses propres tags == On peut également créer ses propres tags avec le code suivant :


namespace boost {
    enum vertex_data_t { vertex_data };
    BOOST_INSTALL_PROPERTY(vertex, data);
}
using VertexProperties =property;

== Enregistrer plusieurs informations par élément du graphe == Boost property prend un troisième paramètre template, permettant de chaîner plusieurs propriétés :


boost::property  > >	// distance

Dans ce cas, il est nécessaire d'utiliser les fonctions ''put'' et ''get'' en indiquant le tag utilisé pour récupérer la ''property_map'' correspondant au tag :


// modifier le nom
get(boost::vertex_name_t, g)[v1] = "titi";
 
// afficher le nom
std::cout << "Vertex name : " << get(boost::vertex_name_t, g)[v1] << std::endl;

==== Représentation interne et adjacent_matrix ==== La classe ''adjacent_list utilise'' en interne une liste de sommets aux quels sont associés une liste d'arcs. Il existe une autre structure, ''adjacent_matrix'', qui utilise un tableau 2D pour représenter chaque arc, ce qui permet un accès en O(1) aux arcs. {{ :boost-graph-3.png |}} ^ Figure 3: Représentation interne de adjacent_list et adjacent_matrix ^ ===== Conclusion ===== ==== Références ==== * http://matthieu-brucher.developpez.com/tutoriels/cpp/boost/graph/implementation/ ; * http://www.boost.org/doc/libs/1_60_0/libs/graph/doc/index.html ; * Boost Graph Library, The: User Guide and Reference Manual de Jeremy G. Siek, Lie-Quan Lee et Andrew Lumsdaine. ==== Mises a jour ==== * 25 février 2012 : premiere publication. * 8 avril 2016 : * transfert sur le wiki ; * ajout d'une note sur ''std::tie'', qui est maintenant dans le C++11 ; * mise a jour des liens vers Boost 1.60 ; * remplacement de ''typedef'' en ''using''. ==== Remerciements ==== Merci à 3DArchi, r0d, Luc Hermitte, bretus, Flob90, CedricMocquillon et JolyLoic pour leur relecture et leurs conseils. Merci à djibril pour sa relecture orthographique très attentive.