base_undirected_vertex.hpp

Go to the documentation of this file.

#ifndef BASE_UNDIRECTED_VERTEX_HPP_INCLUDED
#define BASE_UNDIRECTED_VERTEX_HPP_INCLUDED

// Standard Library
#include <list>
#include <string>
#include <vector>
// Graph C++ Library
#include "base_vertex.hpp"

namespace gcl
{

  template <class EdgeAttributesType>
  class base_undirected_vertex : public base_vertex<EdgeAttributesType>
  {
    // ============================================================================================
    // *** Objects related to the vertex.
    protected:
      const unsigned int id_degree;                                               
    // ============================================================================================
    // *** Information about the vertex.
    private:
      unsigned int nb_triangles;                                                  
      double local_clustering_coefficient;                                        
    // ============================================================================================
    // *** Member functions.
    public:
      base_undirected_vertex();                                                   
      virtual ~base_undirected_vertex() {}                                        
      unsigned int get_degree();                                                  
      unsigned int get_nb_triangles();                                            
      double       get_local_clustering_coefficient();                            
      void         set_nb_triangles(unsigned int _value);                         
      void     neighbour_insert(EdgeAttributesType _edge);                        
      typename gcl::base_vertex<EdgeAttributesType>::iterator neighbour_begin();  
      typename gcl::base_vertex<EdgeAttributesType>::iterator neighbour_end();    
    protected:
      void base_undirected_vertex_clear();                                        
  };

} // End of namespace gcl.



// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
gcl::base_undirected_vertex<EdgeAttributesType>::base_undirected_vertex() : id_degree(0) {}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
unsigned int gcl::base_undirected_vertex<EdgeAttributesType>::get_degree()
{
  return this->get_base_vertex_degrees(id_degree);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
unsigned int gcl::base_undirected_vertex<EdgeAttributesType>::get_nb_triangles()
{
  return nb_triangles;
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
double gcl::base_undirected_vertex<EdgeAttributesType>::get_local_clustering_coefficient()
{
  return local_clustering_coefficient;
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
void gcl::base_undirected_vertex<EdgeAttributesType>::set_nb_triangles(unsigned int _value)
{
  // Sets the number of triangles.
  nb_triangles = _value;
  // Computes the local clustering coefficient.
  local_clustering_coefficient = ( 2. * nb_triangles ) / ( this->get_degree() * ( this->get_degree() - 1. ) );
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
void gcl::base_undirected_vertex<EdgeAttributesType>::neighbour_insert(EdgeAttributesType _edge)
{
  this->base_vertex_neighbour_insert(id_degree, _edge);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
typename gcl::base_vertex<EdgeAttributesType>::iterator gcl::base_undirected_vertex<EdgeAttributesType>::neighbour_begin()
{
  return this->base_vertex_neighbour_begin(id_degree);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
typename gcl::base_vertex<EdgeAttributesType>::iterator gcl::base_undirected_vertex<EdgeAttributesType>::neighbour_end()
{
  return this->base_vertex_neighbour_end(id_degree);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
void gcl::base_undirected_vertex<EdgeAttributesType>::base_undirected_vertex_clear()
{
  // Resets the number of types of vertices.
  this->set_nb_of_types_of_degrees(1);
  // Resets the variables inherited from base_vertex.
  this->base_vertex_clear();
  // Resets the number of triangles.
  nb_triangles = 0;
  // Resets the local clustering coefficient.
  local_clustering_coefficient = 0;
}



#endif // BASE_UNDIRECTED_VERTEX_HPP_INCLUDED