operations_research::EbertGraph< NodeIndexType, ArcIndexType >::IncomingArcIterator Class Reference

Iterator class for traversing the incoming arcs associated to a given node. More...

#include <ebert_graph.h>

List of all members.

Public Member Functions
	IncomingArcIterator (const EbertGraph &graph, NodeIndexType node)
	IncomingArcIterator (const EbertGraph &graph, NodeIndexType node, ArcIndexType arc)
	This constructor takes an arc as extra argument and makes the iterator start at arc.
void	operator= (const IncomingArcIterator &iterator)
	Can only assign from an iterator on the same graph.
bool	Ok () const
	Returns true unless all the incoming arcs have been traversed.
void	Next ()
	Advances the current incoming arc index.
ArcIndexType	Index () const
	Returns the index of the arc currently pointed to by the iterator.

---

Detailed Description

template<typename NodeIndexType, typename ArcIndexType>
class operations_research::EbertGraph< NodeIndexType, ArcIndexType >::IncomingArcIterator

Iterator class for traversing the incoming arcs associated to a given node.

Note that the indices of these arc are negative, i.e. it's actually their corresponding direct arcs that are incoming to the node. The API has been designed in this way to have the set of arcs iterated by IncidentArcIterator to be the union of the sets of arcs iterated by IncomingArcIterator and OutgoingArcIterator.

Definition at line 751 of file ebert_graph.h.

---

Constructor & Destructor Documentation

template<typename NodeIndexType, typename ArcIndexType>

operations_research::EbertGraph< NodeIndexType, ArcIndexType >::IncomingArcIterator::IncomingArcIterator	(	const EbertGraph &	graph,
		NodeIndexType	node
	)			[inline]

Definition at line 753 of file ebert_graph.h.

template<typename NodeIndexType, typename ArcIndexType>

operations_research::EbertGraph< NodeIndexType, ArcIndexType >::IncomingArcIterator::IncomingArcIterator	(	const EbertGraph &	graph,
		NodeIndexType	node,
		ArcIndexType	arc
	)			[inline]

This constructor takes an arc as extra argument and makes the iterator start at arc.

Definition at line 762 of file ebert_graph.h.

---

Member Function Documentation

template<typename NodeIndexType, typename ArcIndexType>

void operations_research::EbertGraph< NodeIndexType, ArcIndexType >::IncomingArcIterator::operator=

(

const IncomingArcIterator &

iterator

)

[inline]

Can only assign from an iterator on the same graph.

Definition at line 772 of file ebert_graph.h.

template<typename NodeIndexType, typename ArcIndexType>

bool operations_research::EbertGraph< NodeIndexType, ArcIndexType >::IncomingArcIterator::Ok

(

)

const [inline]

Returns true unless all the incoming arcs have been traversed.

Definition at line 779 of file ebert_graph.h.

template<typename NodeIndexType, typename ArcIndexType>

void operations_research::EbertGraph< NodeIndexType, ArcIndexType >::IncomingArcIterator::Next

(

)

[inline]

Advances the current incoming arc index.

Definition at line 782 of file ebert_graph.h.

template<typename NodeIndexType, typename ArcIndexType>

ArcIndexType operations_research::EbertGraph< NodeIndexType, ArcIndexType >::IncomingArcIterator::Index

(

)

const [inline]

Returns the index of the arc currently pointed to by the iterator.

Definition at line 788 of file ebert_graph.h.

---

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

• or-tools/src/graph/ebert_graph.h