traversal.hpp

/*********************************************************************
 *
 * Linear Arrangement Library - A library that implements a collection
 * algorithms for linear arrangments of graphs.
 *
 * Copyright (C) 2019 - 2024
 *
 * This file is part of Linear Arrangement Library. The full code is available
 * at:
 *      https://github.com/LAL-project/linear-arrangement-library.git
 *
 * Linear Arrangement Library is free software: you can redistribute it
 * and/or modify it under the terms of the GNU Affero General Public License
 * as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Linear Arrangement Library 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Linear Arrangement Library.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Contact:
 *
 *     Lluís Alemany Puig (lluis.alemany.puig@upc.edu)
 *         LQMC (Quantitative, Mathematical, and Computational Linguisitcs)
 *         CQL (Complexity and Quantitative Linguistics Lab)
 *         Jordi Girona St 1-3, Campus Nord UPC, 08034 Barcelona.   CATALONIA, SPAIN
 *         Webpage: https://cqllab.upc.edu/people/lalemany/
 *
 *     Ramon Ferrer i Cancho (rferrericancho@cs.upc.edu)
 *         LQMC (Quantitative, Mathematical, and Computational Linguisitcs)
 *         CQL (Complexity and Quantitative Linguistics Lab)
 *         Office 220, Omega building
 *         Jordi Girona St 1-3, Campus Nord UPC, 08034 Barcelona.   CATALONIA, SPAIN
 *         Webpage: https://cqllab.upc.edu/people/rferrericancho/
 *
 ********************************************************************/
 
#pragma once
 
// C++ includes
#include <functional>
 
// lal includes
#include <lal/basic_types.hpp>
#include <lal/graphs/directed_graph.hpp>
#include <lal/graphs/undirected_graph.hpp>
#include <lal/detail/array.hpp>
#include <lal/detail/queue_array.hpp>
 
namespace lal {
namespace detail {
 
template <
    class graph_t,
    std::enable_if_t< std::is_base_of_v<graphs::graph, graph_t>, bool > = true
>
class BFS {
public:
    typedef std::function<void (const BFS<graph_t>&, const node)> BFS_process_one;
    typedef std::function<void (const BFS<graph_t>&, const node, const node, const bool)> BFS_process_two;
    typedef std::function<bool (const BFS<graph_t>&, const node)> BFS_bool_one;
    typedef std::function<bool (const BFS<graph_t>&, const node, const node, const bool)> BFS_bool_two;
 
public:
 
    static constexpr bool is_graph_directed =
        std::is_base_of_v<graphs::directed_graph, graph_t>;
    // ! Note that this member attribute is public, and so it should not have
    //   a leading 'm_' like the other private/protected members.
 
public:
    BFS(const graph_t& g) noexcept :
        m_G(g),
        m_vis(m_G.get_num_nodes())
    {
        reset();
    }
    ~BFS() noexcept = default;
 
    void reset() noexcept {
        clear_visited();
        m_queue.init(m_G.get_num_nodes());
 
        set_use_rev_edges(false);
        set_process_visited_neighbors(false);
 
        set_terminate_default();
        set_process_current_default();
        set_process_neighbour_default();
        set_node_add_default();
    }
 
    void start_at(const node source) noexcept {
        m_queue.push(source);
        m_vis[source] = 1;
        do_traversal();
    }
 
    void start_at(const std::vector<node>& sources) noexcept {
        for (const node& u : sources) {
            m_queue.push(u);
            m_vis[u] = 1;
        }
        do_traversal();
    }
 
    /* SETTERS */
 
    void set_use_rev_edges(const bool use) noexcept { m_use_rev_edges = use; }
 
    void set_terminate_default() noexcept {
        m_terminate = [](const BFS<graph_t>&, const node) -> bool { return false; };
        m_is_terminate_set = false;
    }
    void set_terminate(const BFS_bool_one& f) noexcept {
        m_terminate = f;
        m_is_terminate_set = true;
    }
 
    void set_process_current_default() noexcept {
        m_process_current = [](const BFS<graph_t>&, const node) -> void { };
        m_is_process_current_set = false;
    }
    void set_process_current(const BFS_process_one& f) noexcept {
        m_process_current = f;
        m_is_process_current_set = true;
    }
 
    void set_process_neighbour_default() noexcept {
        m_process_neighbour = [](const BFS<graph_t>&, const node, const node, const bool) -> void { };
        m_is_process_neighbour_set = false;
    }
    void set_process_neighbour(const BFS_process_two& f) noexcept {
        m_process_neighbour = f;
        m_is_process_neighbour_set = true;
    }
 
    void set_node_add_default() noexcept {
        m_add_node = [](const BFS<graph_t>&, const node, const node, const bool) -> bool { return true; };
        m_is_add_node_set = false;
    }
    void set_node_add(const BFS_bool_two& f) noexcept {
        m_add_node = f;
        m_is_add_node_set = true;
    }
 
    void set_process_visited_neighbors(const bool v) noexcept {
        m_process_visited_neighbors = v;
    }
 
    void clear_visited() noexcept { m_vis.fill(0); }
 
    void clear_queue() noexcept {
        m_queue.reset();
    }
 
    void set_visited(const node u, const char vis) noexcept {
#if defined DEBUG
        assert(vis == 0 or vis == 1);
#endif
        m_vis[u] = vis;
    }
 
    /* GETTERS */
 
    [[nodiscard]] bool node_was_visited(const node u) const noexcept {
        return m_vis[u] == 1;
    }
 
    [[nodiscard]] bool all_visited() const noexcept {
        return std::all_of(m_vis.begin(), m_vis.end(), [](auto x){return x == 1;});
    }
 
    [[nodiscard]] const graph_t& get_graph() const noexcept { return m_G; }
 
    [[nodiscard]] const array<char>& get_visited() const noexcept { return m_vis; }
 
protected:
    void deal_with_neighbour(const node s, const node t, const bool ltr) noexcept
    {
        // Process the neighbour 't' of 's'.
        const bool t_vis = node_was_visited(t);
 
        if ((not t_vis) or (t_vis and m_process_visited_neighbors)) {
            if (m_is_process_neighbour_set) {
                m_process_neighbour(*this, s, t, ltr);
            }
        }
 
        if (not t_vis) {
            const bool add_node =
                m_is_add_node_set ? m_add_node(*this, s, t, ltr) : true;
 
            if (add_node) {
                m_queue.push(t);
                // set node as visited
                m_vis[t] = 1;
            }
        }
    }
 
    void process_neighbors(const node s) noexcept {
        if constexpr (not is_graph_directed) {
            // for undirected graphs
 
            for (const node& t : m_G.get_neighbors(s)) {
                // Edges are processed in the direction "s -> t".
                // This is also the 'natural' orientation of the edge,
                // so this explains the 'true'.
                deal_with_neighbour(s, t, true);
            }
        }
        else {
            // for directed graphs
 
            for (const node& t : m_G.get_out_neighbors(s)) {
                // Edges are processed in the direction "s -> t".
                // This is also the 'natural' orientation of the edge,
                // hence the 'true'.
                deal_with_neighbour(s, t, true);
            }
            // process in-neighbors whenever appropriate
            if (m_use_rev_edges) {
                for (const node& t : m_G.get_in_neighbors(s)) {
                    // Edges are processed in the direction "s -> t".
                    // However, the 'natural' orientation of the edge
                    // is "t -> s", hence the 'false'.
                    deal_with_neighbour(s, t, false);
                }
            }
        }
    }
 
    void do_traversal() noexcept {
        while (m_queue.size() > 0) {
            const node s = m_queue.pop();
 
            // process current node
            if (m_is_process_current_set) {
                m_process_current(*this, s);
            }
 
            // check user-defined early termination condition
            if (m_is_terminate_set) {
                if (m_terminate(*this, s)) { break; }
            }
 
            process_neighbors(s);
        }
    }
 
protected:
    const graph_t& m_G;
 
    queue_array<node> m_queue;
 
    array<char> m_vis;
    bool m_process_visited_neighbors = false;
    bool m_use_rev_edges = false;
 
protected:
    BFS_bool_one m_terminate;
    bool m_is_terminate_set;
 
    BFS_process_one m_process_current;
    bool m_is_process_current_set;
 
    BFS_process_two m_process_neighbour;
    bool m_is_process_neighbour_set;
 
    BFS_bool_two m_add_node;
    bool m_is_add_node_set;
};
 
} // -- namespace detail
} // -- namespace lal