Struct BfsResult 

pub struct BfsResult {
    pub order: Vec<VertexId>,
    pub rank: Vec<Option<usize>>,
    pub parents: Vec<Option<VertexId>>,
    pub pred: Vec<Option<VertexId>>,
    pub succ: Vec<Option<VertexId>>,
    pub dist: Vec<Option<usize>>,
    pub stopped: bool,
}

Results of a breadth-first search (Graph::bfs, Graph::bfs_with).

The per-vertex vectors (rank, parents, pred, succ, dist) have one entry per vertex of the graph, None for vertices that were not visited (e.g. unreachable, outside the restricted set, or not reached because the visitor stopped the search).

Fields

order: Vec<VertexId>

The visited vertices, in visiting order.

rank: Vec<Option<usize>>

The rank (position in order) of each vertex.

parents: Vec<Option<VertexId>>

The parent of each vertex in the BFS forest: None for the roots of the search trees and for unvisited vertices (igraph itself already assigns a parent to vertices that were queued but not yet visited when the visitor stopped the search; the bindings report them as None too, so that parents always describes the visited forest).

pred: Vec<Option<VertexId>>

The vertex visited just before each vertex: None for the roots of the search trees and for unvisited vertices.

succ: Vec<Option<VertexId>>

The vertex visited just after each vertex: None for the last vertex of each search tree and for unvisited vertices. When the visitor stops the search, the successor of the vertex it stopped at is None too.

dist: Vec<Option<usize>>

The distance of each vertex from the root of its search tree.

stopped: bool

true if the visitor closure returned ControlFlow::Break, so that the search ended early.

Implementations

impl BfsResult

pub fn is_visited(&self, v: VertexId) -> bool

Whether vertex v was visited by the search.

pub fn roots(&self) -> Vec<VertexId>

The roots of the search trees, in the order they were used.

In an undirected graph searched with BfsOptions::unreachable set (and no restriction), there is exactly one root per connected component, see Graph::connected_components.

pub fn path_to(&self, v: VertexId) -> Option<Vec<VertexId>>

The path of the BFS forest from the root of v’s search tree down to v (a shortest path in unweighted graphs), or None if v was not visited. Graph::get_shortest_path computes a single such path directly (also with weights).

Trait Implementations

impl Clone for BfsResult

fn clone(&self) -> BfsResult

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BfsResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for BfsResult

impl PartialEq for BfsResult

fn eq(&self, other: &BfsResult) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BfsResult