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

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

#include <vvgraph.h>

List of all members.

Public Member Functions

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

Public Attributes

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

Detailed Description

template<typename VertexContent, typename EdgeContent = _EmptyEdgeContent, bool compact = false>
template<class Neighborhood, class Iterator>
struct graph::VVGraph< VertexContent, EdgeContent, compact >::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 1665 of file vvgraph.h.


Constructor & Destructor Documentation

template<typename VertexContent, typename EdgeContent = _EmptyEdgeContent, bool compact = false>
template<class Neighborhood , class Iterator >
graph::VVGraph< VertexContent, EdgeContent, compact >::search_result_t< Neighborhood, Iterator >::search_result_t (  )  [inline]

Default constructor.

By default, the search is unsuccessful

Definition at line 1672 of file vvgraph.h.

01673               : found(false)
01674               , neighborhood(0) {}

template<typename VertexContent, typename EdgeContent = _EmptyEdgeContent, bool compact = false>
template<class Neighborhood , class Iterator >
graph::VVGraph< VertexContent, EdgeContent, compact >::search_result_t< Neighborhood, Iterator >::search_result_t ( Iterator  i,
Neighborhood *  n,
bool  ok = true 
) [inline]

Successful constructor.

Definition at line 1679 of file vvgraph.h.

01682               : found(ok)
01683               , it(i)
01684               , neighborhood(n)
01685               {}

template<typename VertexContent, typename EdgeContent = _EmptyEdgeContent, bool compact = false>
template<class Neighborhood , class Iterator >
graph::VVGraph< VertexContent, EdgeContent, compact >::search_result_t< Neighborhood, Iterator >::search_result_t ( const search_result_t< Neighborhood, Iterator > &  copy  )  [inline]

Copy constructor.

Definition at line 1690 of file vvgraph.h.

01691               : found(copy.found)
01692               , it(copy.it)
01693               , neighborhood(copy.neighborhood)
01694               {}


Member Function Documentation

template<typename VertexContent, typename EdgeContent = _EmptyEdgeContent, bool compact = false>
template<class Neighborhood , class Iterator >
graph::VVGraph< VertexContent, EdgeContent, compact >::search_result_t< Neighborhood, Iterator >::operator bool (  )  [inline]

Convert the object to true if the search is successful.

Definition at line 1699 of file vvgraph.h.

01699 { return found; }


Member Data Documentation

template<typename VertexContent, typename EdgeContent = _EmptyEdgeContent, bool compact = false>
template<class Neighborhood , class Iterator >
bool graph::VVGraph< VertexContent, EdgeContent, compact >::search_result_t< Neighborhood, Iterator >::found

True if the search was completely successful.

Definition at line 1704 of file vvgraph.h.

template<typename VertexContent, typename EdgeContent = _EmptyEdgeContent, bool compact = false>
template<class Neighborhood , class Iterator >
Iterator graph::VVGraph< VertexContent, EdgeContent, compact >::search_result_t< Neighborhood, Iterator >::it
template<typename VertexContent, typename EdgeContent = _EmptyEdgeContent, bool compact = false>
template<class Neighborhood , class Iterator >
Neighborhood* graph::VVGraph< VertexContent, EdgeContent, compact >::search_result_t< Neighborhood, Iterator >::neighborhood

The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Fri May 31 15:38:12 2013 for VVE by  doxygen 1.6.3