rooted_tree.hpp

/*********************************************************************
 *
 *  Linear Arrangement Library - A library that implements a collection
 *  algorithms for linear arrangments of graphs.
 *
 *  Copyright (C) 2019 - 2021
 *
 *  This file is part of Linear Arrangement Library. To see the full code
 *  visit the webpage:
 *      https://github.com/lluisalemanypuig/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 (lalemany@cs.upc.edu)
 *          LARCA (Laboratory for Relational Algorithmics, Complexity and Learning)
 *          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)
 *          LARCA (Laboratory for Relational Algorithmics, Complexity and Learning)
 *          CQL (Complexity and Quantitative Linguistics Lab)
 *          Office S124, 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
#if defined DEBUG
#include <cassert>
#endif
#include <vector>
 
// lal includes
#include <lal/graphs/directed_graph.hpp>
#include <lal/graphs/tree.hpp>
#include <lal/graphs/free_tree.hpp>
 
namespace lal {
namespace graphs {
 
class rooted_tree : public directed_graph, virtual public tree {
public:
    /* CONSTRUCTORS */
 
    rooted_tree() noexcept : tree(), directed_graph() { }
    rooted_tree(uint32_t n) noexcept {
        rooted_tree::_init(n);
    }
    rooted_tree(const rooted_tree& r) noexcept : graph(), tree(), directed_graph() {
        copy_full_rooted_tree(r);
    }
#ifndef SWIG
    rooted_tree(rooted_tree&& r) noexcept {
        move_full_rooted_tree(std::move(r));
    }
#endif
    rooted_tree(const free_tree& t, node r) noexcept {
        init_rooted(t, r);
    }
    virtual ~rooted_tree() noexcept { }
 
    /* OPERATORS */
 
#ifndef SWIG
    rooted_tree& operator= (const rooted_tree& r) noexcept {
        copy_full_rooted_tree(r);
        return *this;
    }
    rooted_tree& operator= (rooted_tree&& r) noexcept {
        move_full_rooted_tree(std::move(r));
        return *this;
    }
#endif
 
    /* MODIFIERS */
 
    rooted_tree& add_edge
    (node s, node t, bool norm = true, bool check_norm = true) noexcept;
 
    rooted_tree& add_edge_bulk(node s, node t) noexcept;
 
    void finish_bulk_add(bool norm = true, bool check = true) noexcept;
 
    rooted_tree& add_edges
    (const std::vector<edge>& edges, bool norm = true, bool check_norm = true)
    noexcept;
 
    rooted_tree& set_edges
    (const std::vector<edge>& edges, bool norm = true, bool check_norm = true)
    noexcept;
 
    rooted_tree& remove_edge
    (node s, node t, bool norm = false, bool check_norm = true) noexcept;
 
    rooted_tree& remove_edges
    (const std::vector<edge>& edges, bool norm = true, bool check_norm = true)
    noexcept;
 
    virtual rooted_tree& remove_edges_incident_to
    (node u, bool norm = true, bool check_norm = true)
    noexcept;
 
    void disjoint_union(const rooted_tree& t, bool connect_roots = true)
    noexcept;
 
    bool find_edge_orientation() noexcept;
 
    inline void set_valid_orientation(bool valid) noexcept {
        m_valid_orientation = valid;
    }
 
    void init_rooted(const free_tree& t, node r) noexcept;
 
    void calculate_size_subtrees() noexcept;
 
    void calculate_tree_type() noexcept;
 
    /* SETTERS */
 
    void set_root(node r) noexcept;
 
    /* GETTERS */
 
    inline bool is_rooted() const noexcept { return true; }
 
    inline bool is_rooted_tree() const noexcept
    { return is_tree() and has_root() and is_orientation_valid(); }
 
    inline bool is_orientation_valid() const noexcept { return m_valid_orientation; }
 
    inline node get_root() const noexcept {
#if defined DEBUG
        assert(has_root());
#endif
        return m_root;
    }
    inline bool has_root() const noexcept { return m_has_root; }
 
    inline uint32_t get_num_nodes_subtree(node u) const noexcept {
#if defined DEBUG
        assert(has_node(u));
#endif
        return m_size_subtrees[u];
    }
 
    inline bool are_size_subtrees_valid() const noexcept
    { return m_are_size_subtrees_valid; }
 
    std::vector<edge> get_edges_subtree(node u, bool relab = false) const noexcept;
 
    rooted_tree get_subtree(node u) const noexcept;
 
    free_tree to_free_tree
    (bool norm = true, bool check = true) const noexcept;
 
    head_vector get_head_vector() const noexcept;
 
protected:
    node m_root = 0;
    bool m_has_root = false;
 
    bool m_valid_orientation = false;
 
    std::vector<uint32_t> m_size_subtrees;
    bool m_are_size_subtrees_valid = false;
 
protected:
    virtual void _init(uint32_t n) noexcept;
    virtual void _clear() noexcept;
 
    void call_union_find_after_add(
        node u, node v,
        uint32_t * const root_of,
        uint32_t * const root_size
    ) noexcept;
    void call_union_find_after_add(
        node u, node v,
        uint32_t * const root_of,
        uint32_t * const root_size
    ) const noexcept;
    void call_union_find_after_remove(
        node u, node v,
        uint32_t * const root_of,
        uint32_t * const root_size
    ) noexcept;
    void call_union_find_after_remove(
        node u, node v,
        uint32_t * const root_of,
        uint32_t * const root_size
    ) const noexcept;
 
    void copy_full_rooted_tree(const rooted_tree& r) noexcept;
    void move_full_rooted_tree(rooted_tree&& r) noexcept;
 
private:
    using directed_graph::disjoint_union;
};
 
} // -- namespace graphs
} // -- namespace lal