Struct petgraph::visit::Bfs

source ·
pub struct Bfs<N, VM> {
    pub stack: VecDeque<N>,
    pub discovered: VM,
}
Expand description

A breadth first search (BFS) of a graph.

The traversal starts at a given node and only traverses nodes reachable from it.

Bfs is not recursive.

Bfs does not itself borrow the graph, and because of this you can run a traversal over a graph while still retaining mutable access to it, if you use it like the following example:

use petgraph::Graph;
use petgraph::visit::Bfs;

let mut graph = Graph::<_,()>::new();
let a = graph.add_node(0);

let mut bfs = Bfs::new(&graph, a);
while let Some(nx) = bfs.next(&graph) {
    // we can access `graph` mutably here still
    graph[nx] += 1;
}

assert_eq!(graph[a], 1);

Note: The algorithm may not behave correctly if nodes are removed during iteration. It may not necessarily visit added nodes or edges.

Fields§

§stack: VecDeque<N>

The queue of nodes to visit

§discovered: VM

The map of discovered nodes

Implementations§

source§

impl<N, VM> Bfs<N, VM>
where N: Copy + PartialEq, VM: VisitMap<N>,

source

pub fn new<G>(graph: G, start: N) -> Self
where G: GraphRef + Visitable<NodeId = N, Map = VM>,

Create a new Bfs, using the graph’s visitor map, and put start in the stack of nodes to visit.

source

pub fn next<G>(&mut self, graph: G) -> Option<N>
where G: IntoNeighbors<NodeId = N>,

Return the next node in the bfs, or None if the traversal is done.

Trait Implementations§

source§

impl<N: Clone, VM: Clone> Clone for Bfs<N, VM>

source§

fn clone(&self) -> Bfs<N, VM>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<N, VM> Default for Bfs<N, VM>
where VM: Default,

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<G> Walker<G> for Bfs<G::NodeId, G::Map>

§

type Item = <G as GraphBase>::NodeId

source§

fn walk_next(&mut self, context: G) -> Option<Self::Item>

Advance to the next item
source§

fn iter(self, context: Context) -> WalkerIter<Self, Context>
where Self: Sized, Context: Clone,

Create an iterator out of the walker and given context.

Auto Trait Implementations§

§

impl<N, VM> Freeze for Bfs<N, VM>
where VM: Freeze,

§

impl<N, VM> RefUnwindSafe for Bfs<N, VM>

§

impl<N, VM> Send for Bfs<N, VM>
where VM: Send, N: Send,

§

impl<N, VM> Sync for Bfs<N, VM>
where VM: Sync, N: Sync,

§

impl<N, VM> Unpin for Bfs<N, VM>
where VM: Unpin, N: Unpin,

§

impl<N, VM> UnwindSafe for Bfs<N, VM>
where VM: UnwindSafe, N: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.