rs-graph 0.14.1

/*
 * Copyright (c) 2017, 2018 Frank Fischer <frank-fischer@shadow-soft.de>
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see  <http://www.gnu.org/licenses/>
 */

//! Breath-first-search algorithms.

use graph::{IndexDigraph, IndexGraph, IndexNodeVec};

/// Do a depth-first-search on an undirected graph starting in `u`.
///
/// The function returns the incoming edge of each node.
///
/// # Example
///
/// ```
/// use rs_graph::{LinkedListGraph, Graph, IndexGraph, classes, dfs};
///
/// let g: LinkedListGraph = classes::peterson();
/// let u = g.id2node(0);
/// let tree = dfs::undirected(&g, u);
///
/// let dist = |mut v| {
///     let mut d = 0;
///     while let Some(e) = tree[v] {
///         let (x,y) = g.enodes(e);
///         d += 1;
///         v = if x == v { y } else { x };
///     }
///     d
/// };
/// let dists: Vec<_> = g.nodes().map(|v| dist(v)).collect();
/// assert!(tree[u].is_none());
/// for n in 0..10 {
///     assert_eq!(dists.iter().filter(|&&d| d == n).count(), 1);
/// }
/// ```
pub fn undirected<'g, G>(g: &'g G, u: G::Node) -> IndexNodeVec<'g, G, Option<G::Edge>>
where
    G: IndexGraph<'g>,
{
    let mut preds = idxnodevec![g; None];
    let mut stack = Vec::new();

    stack.push(g.neighs(u));

    while let Some(mut vneighs) = stack.pop() {
        if let Some((e, w)) = vneighs.next() {
            stack.push(vneighs);
            if w != u && preds[w].is_none() {
                preds[w] = Some(e);
                stack.push(g.neighs(w));
            }
        }
    }

    preds
}

/// Do a depth-first-search on an directed graph starting in `u`.
///
/// The search traverses edges only in forward direction.
///
/// The function returns the incoming edge of each node.
pub fn directed<'g, G>(g: &'g G, u: G::Node) -> IndexNodeVec<'g, G, Option<G::Edge>>
where
    G: IndexDigraph<'g>,
{
    let mut preds = idxnodevec![g; None];
    let mut stack = Vec::new();

    stack.push(g.outedges(u));

    while let Some(mut voutedges) = stack.pop() {
        if let Some((e, w)) = voutedges.next() {
            stack.push(voutedges);
            if w != u && preds[w].is_none() {
                preds[w] = Some(e);
                stack.push(g.outedges(w));
            }
        }
    }

    preds
}