gcl::real_directed_vertex Class Reference

Class for vertices in real directed graphs. More...

#include <real_directed_vertex.hpp>

Inheritance diagram for gcl::real_directed_vertex:

Public Types
typedef std::list < gcl::simple_edge >::iterator	iterator
	Typedef for iterators used to browse the neighbourhood of the vertex.

Public Member Functions
	real_directed_vertex ()
	Constructor.
	~real_directed_vertex ()
	Destructor.
void	clear ()
	Reinitializes the vertex.
unsigned int	get_in_degree ()
	Returns the degree of the vertex.
unsigned int	get_out_degree ()
	Returns the degree of the vertex.
unsigned int	get_undirected_projection_degree ()
	Returns the degree that the vertex has in the undirected version of the directed graph.
unsigned int	get_nb_reciprocal_edges ()
	Returns the number of reciprocal edges the vertex has.
unsigned int	get_nb_undirected_projection_triangles ()
	Returns the number of triangles the vertex is a part of (regardless of the direction of the edges).
double	get_local_undirected_projection_clustering_coefficient ()
	Returns the local clustering coefficient (regardless of the direction of the edges).
void	set_nb_undirected_projection_triangles (unsigned int _value)
	Sets the number of triangles the vertex is a part of (regardless of the direction of the edges).
void	set_nb_reciprocal_edges (unsigned int _value)
	Sets the number of reciprocal edges the vertiex has.
void	in_neighbour_insert (gcl::simple_edge_edge)
	Adds a vertex to the in neighbourhood of the vertex.
void	out_neighbour_insert (gcl::simple_edge_edge)
	Adds a vertex to the out neighbourhood of the vertex.
gcl::base_vertex < gcl::simple_edge >::iterator	in_neighbour_begin ()
	Returns an operator pointing at the beginning the in neighbours container.
gcl::base_vertex < gcl::simple_edge >::iterator	in_neighbour_end ()
	Returns an operator pointing at the end the in neighbours container.
gcl::base_vertex < gcl::simple_edge >::iterator	out_neighbour_begin ()
	Returns an operator pointing at the beginning the out neighbours container.
gcl::base_vertex < gcl::simple_edge >::iterator	out_neighbour_end ()
	Returns an operator pointing at the end the out neighbours container.
std::string	get_name ()
	Returns the id of the vertex.
void	set_name (std::string _name)
	Sets the name of the vertex.
unsigned int	get_base_vertex_degrees (unsigned int _type)
	Returns the degree of type _type.

Protected Member Functions
void	base_directed_vertex_clear ()
	Reinitializes the vertex.
void	set_nb_of_types_of_degrees (unsigned int _value)
	Sets the number of types of degrees.
void	base_vertex_neighbour_insert (unsigned int _type, gcl::simple_edge_info)
	Inserts the information of a new neighbour in the neighbours structure.
iterator	base_vertex_neighbour_begin (unsigned int _type)
	Returns an iterator pointing at the begining of neighbours of type _type.
iterator	base_vertex_neighbour_end (unsigned int _type)
	Returns an iterator pointing at the end of neighbours of type _type.
void	base_vertex_clear ()
	Reinitializes the variables in the class base_vertex.

Detailed Description

Class for vertices in real directed graphs.

This class provides the common members attributes and functions for vertex objects in real directed graphs.

Author

Antoine Allard (antoineallard.info)

Date

Sept. 2015

---

The documentation for this class was generated from the following file:

• src/real_directed_vertex.hpp