engine-mk1
Public Member Functions | Public Attributes | List of all members
rz::graph::Vertex< V, E > Struct Template Reference

A template struct for representing Vertex objects. More...

#include <Graph.hpp>

Public Member Functions

 Vertex (std::size_t index)
 Constructs an empty Vertex with the ID index. More...
 
bool operator== (const Vertex< V, E > &rhs) const noexcept
 Basic equality comparator. More...
 

Public Attributes

data {}
 The data held by this Vertex. More...
 
std::list< Edge< E > > adjacencyList {}
 An std::list of connected Edges. More...
 
std::size_t id {}
 An ID that doubles as an index value. More...
 
State state {}
 The current state of the Vertex, represented by a bitfield. More...
 

Detailed Description

template<class V, class E>
struct rz::graph::Vertex< V, E >

A template struct for representing Vertex objects.

Template Parameters
VThe data type held by Vertex objects
EThe data type held by Edge objects

Constructor & Destructor Documentation

template<class V, class E>
rz::graph::Vertex< V, E >::Vertex ( std::size_t  index)
inline

Constructs an empty Vertex with the ID index.

Member Function Documentation

template<class V, class E>
bool rz::graph::Vertex< V, E >::operator== ( const Vertex< V, E > &  rhs) const
inlinenoexcept

Basic equality comparator.

Member Data Documentation

template<class V, class E>
std::list<Edge<E> > rz::graph::Vertex< V, E >::adjacencyList {}

An std::list of connected Edges.

template<class V, class E>
V rz::graph::Vertex< V, E >::data {}

The data held by this Vertex.

template<class V, class E>
std::size_t rz::graph::Vertex< V, E >::id {}

An ID that doubles as an index value.

template<class V, class E>
State rz::graph::Vertex< V, E >::state {}

The current state of the Vertex, represented by a bitfield.


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