#include <graph.h>

Inheritance diagram for util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingOrOppositeIncomingArcIterator:

Public Member Functions
	OutgoingOrOppositeIncomingArcIterator (const ReverseArcListGraph &graph, NodeIndexType node)

	OutgoingOrOppositeIncomingArcIterator (const ReverseArcListGraph &graph, NodeIndexType node, ArcIndexType arc)

bool	Ok () const

ArcIndexType	Index () const

void	Next ()

	DEFINE_STL_ITERATOR_FUNCTIONS (OutgoingOrOppositeIncomingArcIterator)

bool	IsArcValid (ArcIndexType arc) const

	ReverseArcListGraph ()

	ReverseArcListGraph (NodeIndexType num_nodes, ArcIndexType arc_capacity)

ArcIndexType	OppositeArc (ArcIndexType arc) const

ArcIndexType	OutDegree (NodeIndexType node) const
	ReverseArcListGraph<>::OutDegree() and InDegree() work in O(degree).

ArcIndexType	InDegree (NodeIndexType node) const

BeginEndWrapper< OutgoingArcIterator >	OutgoingArcs (NodeIndexType node) const

BeginEndWrapper< IncomingArcIterator >	IncomingArcs (NodeIndexType node) const

BeginEndWrapper< OutgoingOrOppositeIncomingArcIterator >	OutgoingOrOppositeIncomingArcs (NodeIndexType node) const

BeginEndWrapper< OppositeIncomingArcIterator >	OppositeIncomingArcs (NodeIndexType node) const

BeginEndWrapper< OutgoingArcIterator >	OutgoingArcsStartingFrom (NodeIndexType node, ArcIndexType from) const

BeginEndWrapper< IncomingArcIterator >	IncomingArcsStartingFrom (NodeIndexType node, ArcIndexType from) const

BeginEndWrapper< OutgoingOrOppositeIncomingArcIterator >	OutgoingOrOppositeIncomingArcsStartingFrom (NodeIndexType node, ArcIndexType from) const

BeginEndWrapper< OppositeIncomingArcIterator >	OppositeIncomingArcsStartingFrom (NodeIndexType node, ArcIndexType from) const

BeginEndWrapper< OutgoingHeadIterator >	operator[] (NodeIndexType node) const

NodeIndexType	Head (ArcIndexType arc) const

NodeIndexType	Tail (ArcIndexType arc) const

void	ReserveNodes (NodeIndexType bound) override

void	ReserveArcs (ArcIndexType bound) override

void	AddNode (NodeIndexType node)

ArcIndexType	AddArc (NodeIndexType tail, NodeIndexType head)

void	Build ()

void	Build (std::vector< ArcIndexType > *permutation)

bool	IsArcValid (ArcIndexType arc) const

Public Member Functions inherited from util::BaseGraph< NodeIndexType, ArcIndexType, true >
	BaseGraph ()

	BaseGraph (const BaseGraph &)=default

BaseGraph &	operator= (const BaseGraph &)=default

virtual	~BaseGraph ()=default

NodeIndexType	num_nodes () const

NodeIndexType	size () const

ArcIndexType	num_arcs () const
	Returns the number of valid arcs in the graph.

IntegerRange< NodeIndex >	AllNodes () const
	BaseGraph implementation -------------------------------------------------—.

IntegerRange< ArcIndex >	AllForwardArcs () const

bool	IsNodeValid (NodeIndexType node) const
	Returns true if the given node is a valid node of the graph.

bool	IsArcValid (ArcIndexType arc) const

NodeIndexType	node_capacity () const
	Capacity reserved for future nodes, always >= num_nodes_.

ArcIndexType	arc_capacity () const
	Capacity reserved for future arcs, always >= num_arcs_.

void	Reserve (NodeIndexType node_capacity, ArcIndexType arc_capacity)

void	FreezeCapacities ()

	BaseGraph ()

	BaseGraph (const BaseGraph &)=default

BaseGraph &	operator= (const BaseGraph &)=default

virtual	~BaseGraph ()=default

NodeIndexType	num_nodes () const

NodeIndexType	size () const

ArcIndexType	num_arcs () const
	Returns the number of valid arcs in the graph.

IntegerRange< NodeIndex >	AllNodes () const
	BaseGraph implementation -------------------------------------------------—.

IntegerRange< ArcIndex >	AllForwardArcs () const

bool	IsNodeValid (NodeIndexType node) const
	Returns true if the given node is a valid node of the graph.

bool	IsArcValid (ArcIndexType arc) const

NodeIndexType	node_capacity () const
	Capacity reserved for future nodes, always >= num_nodes_.

ArcIndexType	arc_capacity () const
	Capacity reserved for future arcs, always >= num_arcs_.

void	Reserve (NodeIndexType node_capacity, ArcIndexType arc_capacity)

void	FreezeCapacities ()

Additional Inherited Members
Public Types inherited from util::BaseGraph< NodeIndexType, ArcIndexType, true >
typedef NodeIndexType	NodeIndex

typedef ArcIndexType	ArcIndex

Static Public Attributes inherited from util::BaseGraph< NodeIndexType, ArcIndexType, true >
static constexpr bool	kHasNegativeReverseArcs

static const NodeIndexType	kNilNode

static const ArcIndexType	kNilArc

static constexpr bool	kHasNegativeReverseArcs

static const NodeIndexType	kNilNode

static const ArcIndexType	kNilArc

Protected Member Functions inherited from util::BaseGraph< NodeIndexType, ArcIndexType, true >
void	ComputeCumulativeSum (std::vector< ArcIndexType > *v)
	Functions commented when defined because they are implementation details.

void	BuildStartAndForwardHead (SVector< NodeIndexType > head, std::vector< ArcIndexType > start, std::vector< ArcIndexType > *permutation)

void	ComputeCumulativeSum (std::vector< ArcIndexType > *v)
	Functions commented when defined because they are implementation details.

void	BuildStartAndForwardHead (SVector< NodeIndexType > head, std::vector< ArcIndexType > start, std::vector< ArcIndexType > *permutation)

Protected Attributes inherited from util::BaseGraph< NodeIndexType, ArcIndexType, true >
NodeIndexType	num_nodes_

NodeIndexType	node_capacity_

ArcIndexType	num_arcs_

ArcIndexType	arc_capacity_

bool	const_capacities_

NodeIndexType	num_nodes_

NodeIndexType	node_capacity_

ArcIndexType	num_arcs_

ArcIndexType	arc_capacity_

bool	const_capacities_

Detailed Description

template<typename NodeIndexType = int32_t, typename ArcIndexType = int32_t>
class util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingOrOppositeIncomingArcIterator

Definition at line 1671 of file graph.h.

Constructor & Destructor Documentation

◆ OutgoingOrOppositeIncomingArcIterator() [1/2]

template<typename NodeIndexType = int32_t, typename ArcIndexType = int32_t>

util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingOrOppositeIncomingArcIterator::OutgoingOrOppositeIncomingArcIterator	(	const ReverseArcListGraph &	graph,
		NodeIndexType	node )

inline

Definition at line 1674 of file graph.h.

◆ OutgoingOrOppositeIncomingArcIterator() [2/2]

template<typename NodeIndexType = int32_t, typename ArcIndexType = int32_t>

util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingOrOppositeIncomingArcIterator::OutgoingOrOppositeIncomingArcIterator	(	const ReverseArcListGraph &	graph,
		NodeIndexType	node,
		ArcIndexType	arc )

inline

Definition at line 1680 of file graph.h.

Member Function Documentation

◆ AddArc()

ArcIndexType util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::AddArc	(	NodeIndexType	tail,
		NodeIndexType	head )

Definition at line 542 of file graph.h.

◆ AddNode()

void util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::AddNode ( NodeIndexType node )

Definition at line 541 of file graph.h.

◆ Build() [1/2]

void util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::Build ( )

inline

Definition at line 544 of file graph.h.

◆ Build() [2/2]

void util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::Build ( std::vector< ArcIndexType > * permutation )

Definition at line 545 of file graph.h.

◆ DEFINE_STL_ITERATOR_FUNCTIONS()

template<typename NodeIndexType = int32_t, typename ArcIndexType = int32_t>

util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingOrOppositeIncomingArcIterator::DEFINE_STL_ITERATOR_FUNCTIONS ( OutgoingOrOppositeIncomingArcIterator )

◆ Head()

NodeIndexType util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::Head ( ArcIndexType arc ) const

Definition at line 536 of file graph.h.

◆ IncomingArcs()

BeginEndWrapper< IncomingArcIterator > util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::IncomingArcs ( NodeIndexType node ) const

◆ IncomingArcsStartingFrom()

BeginEndWrapper< IncomingArcIterator > util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::IncomingArcsStartingFrom	(	NodeIndexType	node,
		ArcIndexType	from ) const

◆ InDegree()

ArcIndexType util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::InDegree ( NodeIndexType node ) const

Definition at line 506 of file graph.h.

◆ Index()

template<typename NodeIndexType = int32_t, typename ArcIndexType = int32_t>

ArcIndexType util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingOrOppositeIncomingArcIterator::Index ( ) const

inline

Definition at line 1688 of file graph.h.

◆ IsArcValid() [1/2]

( ArcIndexType arc ) const

Returns true if the given arc is a valid arc of the graph.

Note: the arc validity range changes for graph with reverse arcs.

◆ IsArcValid() [2/2]

bool util::BaseGraph< NodeIndexType, ArcIndexType, HasNegativeReverseArcs >::IsArcValid ( ArcIndexType arc ) const

inline

Returns true if the given arc is a valid arc of the graph.

Note: the arc validity range changes for graph with reverse arcs.

Definition at line 485 of file graph.h.

◆ Next()

template<typename NodeIndexType = int32_t, typename ArcIndexType = int32_t>

void util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingOrOppositeIncomingArcIterator::Next ( )

inline

Definition at line 1689 of file graph.h.

◆ Ok()

template<typename NodeIndexType = int32_t, typename ArcIndexType = int32_t>

bool util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingOrOppositeIncomingArcIterator::Ok ( ) const

inline

Definition at line 1687 of file graph.h.

◆ operator[]()

BeginEndWrapper< typename ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingHeadIterator > util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::operator[] ( NodeIndexType node ) const

This loops over the heads of the OutgoingArcs(node). It is just a more convenient way to achieve this. Moreover this interface is used by some graph algorithms.

Definition at line 534 of file graph.h.

◆ OppositeArc()

ArcIndexType util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OppositeArc ( ArcIndexType arc ) const

Returns the opposite arc of a given arc. That is the reverse arc of the given forward arc or the forward arc of a given reverse arc.

Definition at line 495 of file graph.h.

◆ OppositeIncomingArcs()

BeginEndWrapper< OppositeIncomingArcIterator > util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OppositeIncomingArcs ( NodeIndexType node ) const

◆ OppositeIncomingArcsStartingFrom()

BeginEndWrapper< OppositeIncomingArcIterator > util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OppositeIncomingArcsStartingFrom	(	NodeIndexType	node,
		ArcIndexType	from ) const

◆ OutDegree()

ArcIndexType util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutDegree ( NodeIndexType node ) const

ReverseArcListGraph<>::OutDegree() and InDegree() work in O(degree).

Definition at line 505 of file graph.h.

◆ OutgoingArcs()

BeginEndWrapper< OutgoingArcIterator > util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingArcs ( NodeIndexType node ) const

Arc iterations functions over the arcs touching a node (see the top-level comment for the different types). To be used as follows: for (const Graph::ArcIndex arc : IterationFunction(node)) { ... }

The StartingFrom() version are similar, but restart the iteration from a given arc position (which must be valid in the iteration context), or kNilArc, in which case an empty range is returned.

◆ OutgoingArcsStartingFrom()

BeginEndWrapper< OutgoingArcIterator > util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingArcsStartingFrom	(	NodeIndexType	node,
		ArcIndexType	from ) const

◆ OutgoingOrOppositeIncomingArcs()

BeginEndWrapper< OutgoingOrOppositeIncomingArcIterator > util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingOrOppositeIncomingArcs ( NodeIndexType node ) const

◆ OutgoingOrOppositeIncomingArcsStartingFrom()

BeginEndWrapper< OutgoingOrOppositeIncomingArcIterator > util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::OutgoingOrOppositeIncomingArcsStartingFrom	(	NodeIndexType	node,
		ArcIndexType	from ) const

◆ ReserveArcs()

void util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::ReserveArcs ( ArcIndexType bound )

overridevirtual

Reimplemented from util::BaseGraph< NodeIndexType, ArcIndexType, true >.

Definition at line 540 of file graph.h.

◆ ReserveNodes()

void util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::ReserveNodes ( NodeIndexType bound )

overridevirtual

Reimplemented from util::BaseGraph< NodeIndexType, ArcIndexType, true >.

Definition at line 539 of file graph.h.

◆ ReverseArcListGraph() [1/2]

util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::ReverseArcListGraph ( )

inline

Definition at line 486 of file graph.h.

◆ ReverseArcListGraph() [2/2]

util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::ReverseArcListGraph	(	NodeIndexType	num_nodes,
		ArcIndexType	arc_capacity )

inline

Definition at line 487 of file graph.h.

◆ Tail()

NodeIndexType util::ReverseArcListGraph< NodeIndexType, ArcIndexType >::Tail ( ArcIndexType arc ) const

Definition at line 537 of file graph.h.

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

ortools/graph/graph.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OutgoingOrOppositeIncomingArcIterator() [1/2]

◆ OutgoingOrOppositeIncomingArcIterator() [2/2]

Member Function Documentation

◆ AddArc()

◆ AddNode()

◆ Build() [1/2]

◆ Build() [2/2]

◆ DEFINE_STL_ITERATOR_FUNCTIONS()

◆ Head()

◆ IncomingArcs()

◆ IncomingArcsStartingFrom()

◆ InDegree()

◆ Index()

◆ IsArcValid() [1/2]

◆ IsArcValid() [2/2]

◆ Next()

◆ Ok()

◆ operator[]()

◆ OppositeArc()

◆ OppositeIncomingArcs()

◆ OppositeIncomingArcsStartingFrom()

◆ OutDegree()

◆ OutgoingArcs()

◆ OutgoingArcsStartingFrom()

◆ OutgoingOrOppositeIncomingArcs()

◆ OutgoingOrOppositeIncomingArcsStartingFrom()

◆ ReserveArcs()

◆ ReserveNodes()

◆ ReverseArcListGraph() [1/2]

◆ ReverseArcListGraph() [2/2]

◆ Tail()