base_directed_vertex.hpp

Go to the documentation of this file.

#ifndef BASE_DIRECTED_VERTEX_HPP_INCLUDED
#define BASE_DIRECTED_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_directed_vertex : public base_vertex<EdgeAttributesType>
  {
    // ============================================================================================
    // *** Objects related to the vertex.
    private:
      const unsigned int id_in_degree;                                
      const unsigned int id_out_degree;                               
    // ============================================================================================
    // *** Information about the vertex.
    private:
      unsigned int undirected_projection_degree;                      
      unsigned int nb_undirected_projection_triangles;                
      double local_undirected_projection_clustering_coefficient;      
      unsigned int nb_reciprocal_edges;                               
    // ============================================================================================
    // *** Member functions.
    public:
      base_directed_vertex();                                                         
      virtual ~base_directed_vertex() {}                                              
      unsigned int get_in_degree();                                                   
      unsigned int get_out_degree();                                                  
      unsigned int get_undirected_projection_degree();                                
      unsigned int get_nb_reciprocal_edges();                                         
      unsigned int get_nb_undirected_projection_triangles();                          
      double       get_local_undirected_projection_clustering_coefficient();          
      void         set_nb_undirected_projection_triangles(unsigned int _value);       
      void         set_nb_reciprocal_edges(unsigned int _value);                      
      void in_neighbour_insert(EdgeAttributesType _edge);                             
      void out_neighbour_insert(EdgeAttributesType _edge);                            
      typename gcl::base_vertex<EdgeAttributesType>::iterator in_neighbour_begin();   
      typename gcl::base_vertex<EdgeAttributesType>::iterator in_neighbour_end();     
      typename gcl::base_vertex<EdgeAttributesType>::iterator out_neighbour_begin();  
      typename gcl::base_vertex<EdgeAttributesType>::iterator out_neighbour_end();    
    protected:
      void base_directed_vertex_clear();                                          
  };

} // End of namespace gcl.



// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
gcl::base_directed_vertex<EdgeAttributesType>::base_directed_vertex() : id_out_degree(0), id_in_degree(1) {}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
unsigned int gcl::base_directed_vertex<EdgeAttributesType>::get_in_degree()
{
  return this->get_base_vertex_degrees(id_in_degree);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
unsigned int gcl::base_directed_vertex<EdgeAttributesType>::get_out_degree()
{
  return this->get_base_vertex_degrees(id_out_degree);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
unsigned int gcl::base_directed_vertex<EdgeAttributesType>::get_undirected_projection_degree()
{
  return undirected_projection_degree;
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
unsigned int gcl::base_directed_vertex<EdgeAttributesType>::get_nb_reciprocal_edges()
{
  return nb_reciprocal_edges;
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
unsigned int gcl::base_directed_vertex<EdgeAttributesType>::get_nb_undirected_projection_triangles()
{
  return nb_undirected_projection_triangles;
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
double gcl::base_directed_vertex<EdgeAttributesType>::get_local_undirected_projection_clustering_coefficient()
{
  return local_undirected_projection_clustering_coefficient;
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
void gcl::base_directed_vertex<EdgeAttributesType>::set_nb_undirected_projection_triangles(unsigned int _value)
{
  // Sets the number of triangles.
  nb_undirected_projection_triangles = _value;
  // Computes the local clustering coefficient.
  local_undirected_projection_clustering_coefficient = ( 2. * nb_undirected_projection_triangles ) / (undirected_projection_degree * (undirected_projection_degree - 1));
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
void gcl::base_directed_vertex<EdgeAttributesType>::set_nb_reciprocal_edges(unsigned int _value)
{
  // Sets the number of reciprocal edges.
  nb_reciprocal_edges = _value;
  // Computes the projected undirected degree.
  undirected_projection_degree = this->get_out_degree() + this->get_in_degree() - ( this->get_nb_reciprocal_edges() / 2 ) ;
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
void gcl::base_directed_vertex<EdgeAttributesType>::in_neighbour_insert(EdgeAttributesType _edge)
{
  this->base_vertex_neighbour_insert(id_in_degree, _edge);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
void gcl::base_directed_vertex<EdgeAttributesType>::out_neighbour_insert(EdgeAttributesType _edge)
{
  this->base_vertex_neighbour_insert(id_out_degree, _edge);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
typename gcl::base_vertex<EdgeAttributesType>::iterator gcl::base_directed_vertex<EdgeAttributesType>::in_neighbour_begin()
{
  return this->base_vertex_neighbour_begin(id_in_degree);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
typename gcl::base_vertex<EdgeAttributesType>::iterator gcl::base_directed_vertex<EdgeAttributesType>::in_neighbour_end()
{
  return this->base_vertex_neighbour_end(id_in_degree);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
typename gcl::base_vertex<EdgeAttributesType>::iterator gcl::base_directed_vertex<EdgeAttributesType>::out_neighbour_begin()
{
  return this->base_vertex_neighbour_begin(id_out_degree);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
typename gcl::base_vertex<EdgeAttributesType>::iterator gcl::base_directed_vertex<EdgeAttributesType>::out_neighbour_end()
{
  return this->base_vertex_neighbour_end(id_out_degree);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
void gcl::base_directed_vertex<EdgeAttributesType>::base_directed_vertex_clear()
{
  // Resets the number of types of vertices.
  this->set_nb_of_types_of_degrees(2);
  // Resets the variables inherited from base_vertex.
  this->base_vertex_clear();
  // Resets various objects.
  nb_reciprocal_edges = 0;
  nb_undirected_projection_triangles = 0;
  local_undirected_projection_clustering_coefficient = 0;
  undirected_projection_degree = 0;
}



#endif // BASE_DIRECTED_VERTEX_HPP_INCLUDED