Public Types
using	IndexType = TIndex
	Index type used in the breadth-first search.

using	QueueType = std::queue<IndexType>
	Queue type used for BFS.

Public Member Functions
	BreadthFirstSearch (Eigen::Index n)
	Construct a new Breadth First Search object.

void	Reserve (Eigen::Index n)
	Reserve memory for `n` vertices.

template<class FVisit, class TDerivedP, class TDerivedAdj>
void	operator() (Eigen::DenseBase< TDerivedP > const &ptr, Eigen::DenseBase< TDerivedAdj > const &adj, TIndex start, FVisit fVisit)
	Perform depth-first search on the graph.

Eigen::Index	NumVertices () const
	Get the number of vertices in the graph.

Public Attributes
Eigen::Vector< bool, Eigen::Dynamic >	visited
	`\|# vertices\| x 1` visited mask

QueueType	queue
	BFS search queue.

Constructor & Destructor Documentation

◆ BreadthFirstSearch()

template<common::CIndex TIndex>

pbat::graph::BreadthFirstSearch< TIndex >::BreadthFirstSearch ( Eigen::Index n )

inline

Construct a new Breadth First Search object.

Parameters

n	Number of vertices in the graph

template<common::CIndex TIndex = Index>

Eigen::Index pbat::graph::BreadthFirstSearch< TIndex >::NumVertices ( ) const

inline

Get the number of vertices in the graph.

template<common::CIndex TIndex>

template<class FVisit, class TDerivedP, class TDerivedAdj>

void pbat::graph::BreadthFirstSearch< TIndex >::operator()	(	Eigen::DenseBase< TDerivedP > const &	ptr,
		Eigen::DenseBase< TDerivedAdj > const &	adj,
		TIndex	start,
		FVisit	fVisit )

inline

Perform depth-first search on the graph.

Template Parameters

FVisit	Callable type with signature `void(IndexType)`
TDerivedP	Type of the pointer vector (adjacency list start indices for each vertex)
TDerivedAdj	Type of the adjacency list (vector of vertex indices)

Parameters

ptr	Pointer to the start of each vertex's adjacency list
adj	Adjacency list of the graph
start	Starting vertex index
fVisit	Function to call for each visited vertex

template<common::CIndex TIndex>

void pbat::graph::BreadthFirstSearch< TIndex >::Reserve ( Eigen::Index n )

inline

Reserve memory for n vertices.

Parameters

n	Number of vertices in the graph

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