base_graph.hpp

Go to the documentation of this file.

#ifndef BASE_GRAPH_HPP_INCLUDED
#define BASE_GRAPH_HPP_INCLUDED

// Standard Library
#include <algorithm> // set_intersection
#include <cstdlib>   // abort
#include <iostream>
#include <set>
#include <string>
#include <vector>

namespace gcl
{

  template <class VertexType>
  class base_graph
  {
    // ============================================================================================
    // *** Objects related to the graph.
    private:
      std::vector< VertexType > the_graph;                           
      unsigned int nb_of_types_of_degrees;                           
    // ============================================================================================
    // *** Information about the graph.
    private:
      std::string type_of_graph;                                     
      unsigned int nb_vertices;                                      
      unsigned int nb_edges;                                         
      // std::vector< std::vector<unsigned int> > degrees_distribution; ///< Degrees distributions (in absolute number of vertices).
      std::vector< unsigned int > min_degrees;                       
      std::vector< unsigned int > max_degrees;                       
      std::vector< double >       avg_degrees;                       
      unsigned int                nb_zerodegree_vertices;            
    // ============================================================================================
    // *** Status of the properties computed.
    protected:
      bool have_the_degree_distributions_been_surveyed;
    // ============================================================================================
    // *** Member functions.
    public:
      base_graph() {}                                                
      virtual ~base_graph() {}                                       
      std::string  get_type_of_graph();                              
      unsigned int get_nb_vertices();                                
      unsigned int get_nb_edges();                                   
      unsigned int get_nb_zerodegree_vertices();                     
      void         survey_degrees_distribution();                    
      VertexType*  operator()(unsigned int _id);                     
      virtual void write_edgelist(std::string _name) = 0;            
      virtual void clear() = 0;                                      
    protected:
      void         set_type_of_graph(std::string _type_of_graph);    
      void         set_nb_vertices(unsigned int _value);             
      void         set_nb_edges(unsigned int _value);                
      void         set_nb_of_types_of_degrees(unsigned int _value);  
      unsigned int get_base_graph_min_degrees(unsigned int _type);   
      unsigned int get_base_graph_max_degrees(unsigned int _type);   
      double       get_base_graph_avg_degrees(unsigned int _type);   
      void         base_graph_clear();                               
  };

} // End of namespace gcl.



// ================================================================================================
// ================================================================================================
template <class VertexType>
std::string gcl::base_graph<VertexType>::get_type_of_graph()
{
  return type_of_graph;
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
unsigned int gcl::base_graph<VertexType>::get_nb_vertices()
{
  return nb_vertices;
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
unsigned int gcl::base_graph<VertexType>::get_nb_edges()
{
  return nb_edges;
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
unsigned int gcl::base_graph<VertexType>::get_nb_zerodegree_vertices()
{
  return nb_zerodegree_vertices;
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
VertexType* gcl::base_graph<VertexType>::operator()(unsigned int _id)
{
  return &the_graph[_id];
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
void gcl::base_graph<VertexType>::set_nb_vertices(unsigned int _value)
{
  nb_vertices = _value;
  the_graph.resize(nb_vertices);
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
void gcl::base_graph<VertexType>::set_nb_edges(unsigned int _value)
{
  nb_edges = _value;
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
void gcl::base_graph<VertexType>::set_type_of_graph(std::string _type_of_graph)
{
  type_of_graph = _type_of_graph;
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
void gcl::base_graph<VertexType>::set_nb_of_types_of_degrees(unsigned int _value)
{
  nb_of_types_of_degrees = _value;
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
unsigned int gcl::base_graph<VertexType>::get_base_graph_min_degrees(unsigned int _type)
{
  return min_degrees[_type];
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
unsigned int gcl::base_graph<VertexType>::get_base_graph_max_degrees(unsigned int _type)
{
  return max_degrees[_type];
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
double gcl::base_graph<VertexType>::get_base_graph_avg_degrees(unsigned int _type)
{
  return avg_degrees[_type];
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
void gcl::base_graph<VertexType>::survey_degrees_distribution()
{
  // Integer objects.
  unsigned int d, tot_degree;
  // Resizes and sets the initial values of min_degrees, max_degrees and avg_degrees.
  min_degrees.clear();
  min_degrees.resize(nb_of_types_of_degrees,nb_vertices);
  max_degrees.clear();
  max_degrees.resize(nb_of_types_of_degrees,0);
  avg_degrees.clear();
  avg_degrees.resize(nb_of_types_of_degrees,0);
  for(unsigned int n(0); n<nb_vertices; ++n)
  {
    // Resets the sum of the degree of the vertex.
    tot_degree = 0;
    // Sums the degree of the vertex.
    for(unsigned int t(0); t<nb_of_types_of_degrees; ++t)
    {
      tot_degree += the_graph[n].get_base_vertex_degrees(t);
    }
    if(tot_degree == 0)
    {
      // Counts the number of nodes with no edges.
      ++nb_zerodegree_vertices;
    }
    else
    {
      for(unsigned int t(0); t<nb_of_types_of_degrees; ++t)
      {
      // Gets the degree of the node (in-, out-).
      d = the_graph[n].get_base_vertex_degrees(t);
      // Average degree (1 of 2). 
      avg_degrees[t] += d;
      // Maximal and minimal degrees.
      if(d > 0)
        if(d < min_degrees[t])
          min_degrees[t] = d;
      if(d > max_degrees[t])
        max_degrees[t] = d;
      }
    }
  }
  // Average degree (2 of 2).
  for(unsigned int t(0); t<nb_of_types_of_degrees; ++t)
  {
    avg_degrees[t] /= nb_vertices;
  }

  // // Resize the degrees_distribution.
  // degrees_distribution.resize(nb_of_types_of_degrees);
  // // Populates the degree distributions.
  // for(unsigned int t(0); t<nb_of_types_of_degrees; ++t)
  // {
  //   // Resizes the degree distribution.
  //   degrees_distribution[t].resize(max_degrees[t]+1,0);
  //   // Fills the degree distribution.
  //   for(unsigned int n(0); n<nb_vertices; ++n)
  //   {
  //     // Gets the degree of the node (in-, out-).
  //     d = the_graph[n].get_base_vertex_degrees(t);
  //     // Adds the vertex to the degree distribution.
  //     degrees_distribution[t][d] += 1;
  //   }
  // }

  // Indicates that the calculations has been done.
  have_the_degree_distributions_been_surveyed = true;
}

// ================================================================================================
// ================================================================================================
template <class VertexType>
void gcl::base_graph<VertexType>::base_graph_clear()
{
  // Clears the the_graph vector.
  the_graph.clear();
  // Resets the type of the graph.
  type_of_graph = "Base graph";
  // Resets the number of vertices.
  nb_vertices = 0;
  // Resets the number of edges.
  nb_edges = 0; 
  // Resets the degres distribution and related quantities.
  // degrees_distribution.clear();
  // degrees_distribution.resize(nb_of_types_of_degrees);
  min_degrees.clear();
  min_degrees.resize(nb_of_types_of_degrees,0);
  max_degrees.clear();
  max_degrees.resize(nb_of_types_of_degrees,0);
  avg_degrees.clear();
  avg_degrees.resize(nb_of_types_of_degrees,0);
  nb_zerodegree_vertices = 0;
  have_the_degree_distributions_been_surveyed = false;
}



#endif // BASE_GRAPH_HPP_INCLUDED