base_vertex.hpp

Go to the documentation of this file.

#ifndef BASE_VERTEX_HPP_INCLUDED
#define BASE_VERTEX_HPP_INCLUDED

// Standard Library
#include <list>
#include <string>
#include <vector>

namespace gcl
{

  template <class EdgeAttributesType>
  class base_vertex
  {
    // ============================================================================================
    // *** Objects related to the vertex.
    public:
      typedef typename std::list< EdgeAttributesType >::iterator iterator;                    
    private:
      unsigned int nb_of_types_of_degrees;                                                    
    // ============================================================================================
    // *** Information about the vertex.
    private:
      std::string name;                                                                       
      std::vector< std::list< EdgeAttributesType > > neighbours;                              
      std::vector< unsigned int > degrees;                                                    
    // ============================================================================================
    // *** Member functions.
    public:
      base_vertex() {}                                                                        
      virtual ~base_vertex() {}                                                               
      std::string  get_name();                                                                
      void         set_name(std::string _name);                                               
      unsigned int get_base_vertex_degrees(unsigned int _type);                               
      virtual void clear() = 0;                                                               
    protected:
      void     set_nb_of_types_of_degrees(unsigned int _value);                               
      void     base_vertex_neighbour_insert(unsigned int _type, EdgeAttributesType _info);    
      iterator base_vertex_neighbour_begin(unsigned int _type);                               
      iterator base_vertex_neighbour_end(unsigned int _type);                                 
      void     base_vertex_clear();                                                           
  };

} // End of namespace gcl.



// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
std::string gcl::base_vertex<EdgeAttributesType>::get_name()
{
  return name;
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
unsigned int gcl::base_vertex<EdgeAttributesType>::get_base_vertex_degrees(unsigned int _type)
{
  return degrees[_type];
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
void gcl::base_vertex<EdgeAttributesType>::set_name(std::string _name)
{
  name = _name;
}

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

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
void gcl::base_vertex<EdgeAttributesType>::base_vertex_neighbour_insert(unsigned int _type, EdgeAttributesType _info)
{
  // Increases the degree of the vertex.
  degrees[_type] += 1;
  // Adds a vertex to the neighbours list.
  neighbours[_type].push_back(_info);
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
typename gcl::base_vertex<EdgeAttributesType>::iterator gcl::base_vertex<EdgeAttributesType>::base_vertex_neighbour_begin(unsigned int _type)
{
  return neighbours[_type].begin();
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
typename gcl::base_vertex<EdgeAttributesType>::iterator gcl::base_vertex<EdgeAttributesType>::base_vertex_neighbour_end(unsigned int _type)
{
  return neighbours[_type].end();
}

// ================================================================================================
// ================================================================================================
template <class EdgeAttributesType>
void gcl::base_vertex<EdgeAttributesType>::base_vertex_clear()
{
  // Resets the id of the vertex.
  name = "00";
  // Resets the neighbours.
  neighbours.clear();
  neighbours.resize(nb_of_types_of_degrees);
  // Resets the degrees.
  degrees.clear();
  degrees.resize(nb_of_types_of_degrees,0);
}



#endif // BASE_VERTEX_HPP_INCLUDED