diff --git a/src/algorithm/include/HyperGraphStat.hh b/src/algorithm/include/HyperGraphStat.hh index 64a2c91..bd97813 100644 --- a/src/algorithm/include/HyperGraphStat.hh +++ b/src/algorithm/include/HyperGraphStat.hh @@ -1,3 +1,6 @@ +/** + * Définition de l'algorithme de génération des statistiques de l'hypergraphe. + */ #ifndef ALGORITHM_INCLUDE_HPGSTAT #define ALGORITHM_INCLUDE_HPGSTAT @@ -10,27 +13,57 @@ #include "../../model/include/AlgorithmeAbstrait.hh" #include "../../model/include/RStructure.hh" + +/** + * Algorithme de génération des statistiques de l'hypergraphe. + */ class HyperGraphStat : public AlgorithmeAbstrait { public: + /** + * Constructeur. + * @param Pointeur partagé vers l'hypergraphe. + */ HyperGraphStat(const boost::shared_ptr&); + /** + * Obtenir la structure des résultats - inutilisé ici. + * @return La structure des résultats - inutilisé ici. + */ RStructure getResult() const; + /** + * Destructeur. + */ ~HyperGraphStat(); public: + /** + * Obtenir le nombre d'hyper-arêtes. + */ unsigned int getNbrHyperEdge() const; + /** + * Obtenir le nombre d'hyper-vertex. + */ unsigned int getNbrHyperVertex() const; + /** + * Obtenir le nombre de connexions vertex-arêtes. + */ unsigned int getNbrLinks() const; + /** + * Obtenir le rang de l'hypergraphe. + */ unsigned int getRang() const; + /** + * Obtenir le co-rang de l'hypergraphe. + */ unsigned int getCoRang() const; protected: @@ -49,18 +82,33 @@ protected: _ptrHypergrapheAbstrait; /** - * La structure des résultats. + * La structure des résultats - inutilisée ici. */ RStructure _result; + /** + * Le nombre d'hyper-arêtes. + */ unsigned int _nhEdge; + /** + * Le nombre d'hyper-vertex. + */ unsigned int _nhVertex; + /** + * Le nombre de connexions vertex-arêtes + */ unsigned int _nhLink; + /** + * Le rang de l'hypergraphe + */ unsigned int _rang; + /** + * Le co-rang de l'hypergraphe + */ unsigned int _coRang; };