bpp::NeighborIteratorClass< is_const > Class Template Reference

Abstract class for neighbor iterators. More...

#include <Bpp/Graph/GlobalGraph.h>

Inheritance diagram for bpp::NeighborIteratorClass< is_const >:

Public Member Functions
virtual	~NeighborIteratorClass ()
template<bool B = is_const>
	NeighborIteratorClass (const std::map< GlobalGraph::Node, GlobalGraph::Edge > &map, typename std::enable_if< B >::type *=0)
template<bool B = is_const>
	NeighborIteratorClass (std::map< GlobalGraph::Node, GlobalGraph::Edge > &map, typename std::enable_if<!B >::type *=0)
void	next ()
bool	end () const
void	start ()

Protected Types
typedef std::conditional< is_const, const std::map< GlobalGraph::Node, GlobalGraph::Edge > &, std::map< GlobalGraph::Node, GlobalGraph::Edge > & >::type	mapType
typedef std::conditional< is_const, std::map< GlobalGraph::Node, GlobalGraph::Edge >::const_iterator, std::map< GlobalGraph::Node, GlobalGraph::Edge >::iterator >::type	itType

Protected Attributes
mapType	map_
itType	it_
itType	begin_
itType	end_

Detailed Description

template<bool is_const>
class bpp::NeighborIteratorClass< is_const >

Abstract class for neighbor iterators.

Definition at line 748 of file GlobalGraph.h.

Member Typedef Documentation

itType

template<bool is_const>

typedef std::conditional<is_const, std::map<GlobalGraph::Node, GlobalGraph::Edge>::const_iterator, std::map<GlobalGraph::Node, GlobalGraph::Edge>::iterator>::type bpp::NeighborIteratorClass< is_const >::itType

protected

Definition at line 759 of file GlobalGraph.h.

mapType

template<bool is_const>

typedef std::conditional<is_const, const std::map<GlobalGraph::Node, GlobalGraph::Edge>&, std::map<GlobalGraph::Node, GlobalGraph::Edge>&>::type bpp::NeighborIteratorClass< is_const >::mapType

protected

Definition at line 753 of file GlobalGraph.h.

Constructor & Destructor Documentation

~NeighborIteratorClass()

template<bool is_const>

virtual bpp::NeighborIteratorClass< is_const >::~NeighborIteratorClass ( )

inlinevirtual

Definition at line 764 of file GlobalGraph.h.

NeighborIteratorClass() [1/2]

template<bool is_const>

template<bool B = is_const>

bpp::NeighborIteratorClass< is_const >::NeighborIteratorClass ( const std::map< GlobalGraph::Node, GlobalGraph::Edge > &  map, typename std::enable_if< B >::type *  = 0  )

inline

Definition at line 767 of file GlobalGraph.h.

NeighborIteratorClass() [2/2]

template<bool is_const>

template<bool B = is_const>

bpp::NeighborIteratorClass< is_const >::NeighborIteratorClass ( std::map< GlobalGraph::Node, GlobalGraph::Edge > &  map, typename std::enable_if<!B >::type *  = 0  )

inline

Definition at line 774 of file GlobalGraph.h.

Member Function Documentation

end()

template<bool is_const>

bool bpp::NeighborIteratorClass< is_const >::end ( ) const

inline

Definition at line 781 of file GlobalGraph.h.

Referenced by bpp::NodesIteratorClass< Graph::OUTGOINGNEIGHBORITER, is_const >::end(), bpp::NodesIteratorClass< Graph::INCOMINGNEIGHBORITER, is_const >::end(), bpp::EdgesIteratorClass< Graph::OUTGOINGNEIGHBORITER, is_const >::end(), and bpp::EdgesIteratorClass< Graph::INCOMINGNEIGHBORITER, is_const >::end().

next()

template<bool is_const>

void bpp::NeighborIteratorClass< is_const >::next ( )

inline

Definition at line 780 of file GlobalGraph.h.

Referenced by bpp::NodesIteratorClass< Graph::OUTGOINGNEIGHBORITER, is_const >::next(), bpp::NodesIteratorClass< Graph::INCOMINGNEIGHBORITER, is_const >::next(), bpp::EdgesIteratorClass< Graph::OUTGOINGNEIGHBORITER, is_const >::next(), and bpp::EdgesIteratorClass< Graph::INCOMINGNEIGHBORITER, is_const >::next().

start()

template<bool is_const>

void bpp::NeighborIteratorClass< is_const >::start ( )

inline

Definition at line 782 of file GlobalGraph.h.

Referenced by bpp::NodesIteratorClass< Graph::OUTGOINGNEIGHBORITER, is_const >::start(), bpp::NodesIteratorClass< Graph::INCOMINGNEIGHBORITER, is_const >::start(), bpp::EdgesIteratorClass< Graph::OUTGOINGNEIGHBORITER, is_const >::start(), and bpp::EdgesIteratorClass< Graph::INCOMINGNEIGHBORITER, is_const >::start().

Member Data Documentation

begin_

template<bool is_const>

itType bpp::NeighborIteratorClass< is_const >::begin_

protected

Definition at line 761 of file GlobalGraph.h.

end_

template<bool is_const>

itType bpp::NeighborIteratorClass< is_const >::end_

protected

Definition at line 761 of file GlobalGraph.h.

it_

template<bool is_const>

itType bpp::NeighborIteratorClass< is_const >::it_

protected

Definition at line 761 of file GlobalGraph.h.

map_

template<bool is_const>

mapType bpp::NeighborIteratorClass< is_const >::map_

protected

Definition at line 755 of file GlobalGraph.h.

---

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

• Bpp/Graph/GlobalGraph.h