Scine::Molassembler::Graph::InnerBasedIterator< T, isVertexInitialized > Class Template Reference

Templated iterator facade based on PrivateGraph to provide iterative access to atom indices and edge indices. More...

#include <Graph.h>

Public Types
using	iterator_category = std::forward_iterator_tag
using	difference_type = std::ptrdiff_t
using	value_type = T
using	pointer = T
using	reference = T

Public Member Functions
	InnerBasedIterator (InnerBasedIterator &&other) noexcept
InnerBasedIterator &	operator= (InnerBasedIterator &&other) noexcept
	InnerBasedIterator (const InnerBasedIterator &other)
InnerBasedIterator &	operator= (const InnerBasedIterator &other)
template<bool Dependent = isVertexInitialized, std::enable_if_t<!Dependent, int > ...>
	InnerBasedIterator (const PrivateGraph &inner, bool begin)
	Construct an iterator from a graph and a boolean indicating begin/end. More...
template<bool Dependent = isVertexInitialized, std::enable_if_t< Dependent, int > ...>
	InnerBasedIterator (AtomIndex a, const PrivateGraph &inner, bool begin)
	Construct an iterator from an atom index, a graph and a boolean indicating begin/end. More...
InnerBasedIterator &	operator++ ()
	Prefix increment.
InnerBasedIterator	operator++ (int)
	Postfix increment.
value_type	operator* () const
	Dereference.
bool	operator== (const InnerBasedIterator &other) const
	Comparison operator.
bool	operator!= (const InnerBasedIterator &other) const
	Inverts. More...

Private Attributes
std::unique_ptr< Impl >	pImpl_

Detailed Description

template<typename T, bool isVertexInitialized>
class Scine::Molassembler::Graph::InnerBasedIterator< T, isVertexInitialized >

Templated iterator facade based on PrivateGraph to provide iterative access to atom indices and edge indices.

Template Parameters

T	The type the iterator should yield
isVertexInitialized	Whether this iterator accepts an atom index in its constructor.

Note

Although this is templated, there is no implementation in the header in order to hide the underlying Boost Graph types from library consumers. The required template specializations for the type defintions below are supplied in GraphIterators.cpp. Any other instantiations will fail.

Constructor & Destructor Documentation

template<typename T , bool isVertexInitialized>

template<bool Dependent = isVertexInitialized, std::enable_if_t<!Dependent, int > ...>

Scine::Molassembler::Graph::InnerBasedIterator< T, isVertexInitialized >::InnerBasedIterator	(	const PrivateGraph &	inner,
		bool	begin
	)

Construct an iterator from a graph and a boolean indicating begin/end.

Parameters

inner	The PrivateGraph (wrapper around BGL Types)
begin	Whether this iterator denotes a begin or end iterator

Note

This constructor is enabled if the template parameter isVertexInitialized is false

template<typename T , bool isVertexInitialized>

template<bool Dependent = isVertexInitialized, std::enable_if_t< Dependent, int > ...>

Scine::Molassembler::Graph::InnerBasedIterator< T, isVertexInitialized >::InnerBasedIterator	(	AtomIndex	a,
		const PrivateGraph &	inner,
		bool	begin
	)

Construct an iterator from an atom index, a graph and a boolean indicating begin/end.

Parameters

a	An atom index around which adjacent vertices or incident edges are to be iterated over (depending on T)
inner	The PrivateGraph (wrapper around BGL Types)
begin	Whether this iterator denotes a begin or end iterator

Note

This constructor is enabled if the template parameter isVertexInitialized is true

Member Function Documentation

template<typename T , bool isVertexInitialized>

bool Scine::Molassembler::Graph::InnerBasedIterator< T, isVertexInitialized >::operator!=

(

const InnerBasedIterator< T, isVertexInitialized > &

other

)

const

Inverts.

See Also

operator ==

---

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

• Molassembler/Graph.h