mgx::VVGraph< VertexContent, EdgeContent >::search_result_t< Neighborhood, Iterator > Struct Template Reference

Type of the result of the search for a vertex in a neighborhood. More...

#include <VVGraph.hpp>

Public Member Functions
	search_result_t ()
	Default constructor. More...
	search_result_t (Iterator i, Neighborhood *n, bool ok=true)
	Successful constructor. More...
	search_result_t (const search_result_t &copy)
	Copy constructor. More...
	operator bool ()
	Convert the object to true if the search is successful. More...

Public Attributes
bool	found
	True if the search was completely successful. More...
Iterator	it
	Iterator pointing in the edge list. More...
Neighborhood *	neighborhood
	Neighborhood containing the element. More...

Detailed Description

template<typename VertexContent, typename EdgeContent = _EmptyEdgeContent>
template<class Neighborhood, class Iterator>
struct mgx::VVGraph< VertexContent, EdgeContent >::search_result_t< Neighborhood, Iterator >

Type of the result of the search for a vertex in a neighborhood.

This data structure is made such that all edit or lookup operations can be done from that data structure.

Definition at line 1233 of file VVGraph.hpp.

Constructor & Destructor Documentation

search_result_t() [1/3]

template<typename VertexContent , typename EdgeContent = _EmptyEdgeContent>

template<class Neighborhood , class Iterator >

mgx::VVGraph< VertexContent, EdgeContent >::search_result_t< Neighborhood, Iterator >::search_result_t ( )

inline

Default constructor.

By default, the search is unsuccessful

Definition at line 1240 of file VVGraph.hpp.

search_result_t() [2/3]

template<typename VertexContent , typename EdgeContent = _EmptyEdgeContent>

template<class Neighborhood , class Iterator >

mgx::VVGraph< VertexContent, EdgeContent >::search_result_t< Neighborhood, Iterator >::search_result_t ( Iterator  i, Neighborhood *  n, bool  ok = true  )

inline

Successful constructor.

Definition at line 1245 of file VVGraph.hpp.

search_result_t() [3/3]

template<typename VertexContent , typename EdgeContent = _EmptyEdgeContent>

template<class Neighborhood , class Iterator >

mgx::VVGraph< VertexContent, EdgeContent >::search_result_t< Neighborhood, Iterator >::search_result_t ( const search_result_t< Neighborhood, Iterator > &  copy )

inline

Copy constructor.

Definition at line 1251 of file VVGraph.hpp.

Member Function Documentation

operator bool()

template<typename VertexContent , typename EdgeContent = _EmptyEdgeContent>

template<class Neighborhood , class Iterator >

mgx::VVGraph< VertexContent, EdgeContent >::search_result_t< Neighborhood, Iterator >::operator bool ( )

inline

Convert the object to true if the search is successful.

Definition at line 1257 of file VVGraph.hpp.

Member Data Documentation

found

template<typename VertexContent , typename EdgeContent = _EmptyEdgeContent>

template<class Neighborhood , class Iterator >

bool mgx::VVGraph< VertexContent, EdgeContent >::search_result_t< Neighborhood, Iterator >::found

True if the search was completely successful.

Definition at line 1265 of file VVGraph.hpp.

it

template<typename VertexContent , typename EdgeContent = _EmptyEdgeContent>

template<class Neighborhood , class Iterator >

Iterator mgx::VVGraph< VertexContent, EdgeContent >::search_result_t< Neighborhood, Iterator >::it

Iterator pointing in the edge list.

Definition at line 1269 of file VVGraph.hpp.

neighborhood

template<typename VertexContent , typename EdgeContent = _EmptyEdgeContent>

template<class Neighborhood , class Iterator >

Neighborhood* mgx::VVGraph< VertexContent, EdgeContent >::search_result_t< Neighborhood, Iterator >::neighborhood

Neighborhood containing the element.

Definition at line 1273 of file VVGraph.hpp.

---

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

• src/VVGraph.hpp