free_tree.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
 
// lal includes
#include <lal/linear_arrangement.hpp>
#include <lal/graphs/undirected_graph.hpp>
#include <lal/graphs/tree.hpp>
 
namespace lal {
namespace graphs {
 
class free_tree : public undirected_graph, virtual public tree {
public:
    friend class rooted_tree;
 
public:
    /* CONSTRUCTORS */
 
    free_tree() noexcept : tree(), undirected_graph() { }
    free_tree(const uint64_t n) noexcept {
        free_tree::_init(n);
    }
    free_tree(const free_tree& t) noexcept : graph(), tree(), undirected_graph() {
        copy_full_free_tree(t);
    }
 
    free_tree(free_tree&& t) noexcept {
        move_full_free_tree(std::forward<free_tree>(t));
    }
 
    free_tree(const undirected_graph& t) noexcept;
 
    free_tree(undirected_graph&& t) noexcept;
 
    ~free_tree() noexcept { }
 
    /* OPERATORS */
 
    free_tree& operator= (const free_tree& f) noexcept {
        copy_full_free_tree(f);
        return *this;
    }
    free_tree& operator= (free_tree&& f) noexcept {
        move_full_free_tree(std::forward<free_tree>(f));
        return *this;
    }
 
    /* MODIFIERS */
 
    free_tree& add_node() noexcept {
        undirected_graph::add_node();
        tree_only_add_node();
        return *this;
    }
 
    free_tree& remove_node
    (
        const node u,
        const bool norm = true,
        const bool check_norm = true
    )
    noexcept;
 
    free_tree& add_edge
    (
        const node s,
        const node t,
        const bool norm = true,
        const bool check_norm = true
    )
    noexcept;
 
    free_tree& add_edge_bulk(const node s, const node t) noexcept;
 
    void finish_bulk_add(const bool norm = true, const bool check = true) noexcept;
 
    void finish_bulk_add_complete(const bool norm = true, const bool check = true) noexcept;
 
    free_tree& add_edges
    (
        const std::vector<edge>& edges,
        const bool norm = true,
        const bool check_norm = true
    )
    noexcept;
 
    free_tree& set_edges
    (
        const std::vector<edge>& edges,
        const bool norm = true,
        const bool check_norm = true
    )
    noexcept;
 
    free_tree& remove_edge
    (
        const node s,
        const node t,
        const bool norm = false,
        const bool check_norm = true
    )
    noexcept;
 
    free_tree& remove_edge_bulk(const node s, const node t) noexcept;
 
    void finish_bulk_remove(const bool norm = true, const bool check = true) noexcept;
 
    void finish_bulk_remove_complete(const bool norm = true, const bool check = true) noexcept;
 
    free_tree& remove_edges
    (
        const std::vector<edge>& edges,
        const bool norm = true,
        const bool check_norm = true
    )
    noexcept;
 
    free_tree& remove_edges_incident_to
    (
        const node u,
        const bool norm = true,
        const bool check_norm = true
    )
    noexcept;
 
    free_tree& disjoint_union(const free_tree& t) noexcept;
 
    void calculate_tree_type() noexcept;
 
    /* GETTERS */
 
    bool is_rooted() const noexcept { return false; }
 
    [[nodiscard]] head_vector get_head_vector
    (const node r = 0, const linear_arrangement& arr = {})
    const noexcept;
 
protected:
    void _init(const uint64_t n) noexcept {
        tree::tree_only_init(n);
        undirected_graph::_init(n);
    }
    void _clear() noexcept {
        undirected_graph::_clear();
        tree::tree_only_clear();
    }
 
    void actions_after_add_edge(const node u, const node v) noexcept;
 
    void actions_after_add_edges(const edge_list& e) noexcept;
 
    void actions_after_add_edges_bulk() noexcept;
 
    void actions_after_remove_edge(const node u, const node v) noexcept;
 
    void actions_after_remove_edges(const edge_list& e) noexcept;
 
    void actions_after_remove_edges_bulk() noexcept;
 
    void actions_after_remove_node(const node u) noexcept;
 
    void actions_before_remove_edges_incident_to(const node u) noexcept;
 
    void update_union_find_after_add_edge
    (
        const node u,
        const node v,
        uint64_t * const root_of,
        uint64_t * const root_size
    )
    const noexcept;
 
    void update_union_find_after_add_edges
    (
        const edge_list& edges,
        uint64_t * const root_of,
        uint64_t * const root_size
    )
    const noexcept;
 
    void update_union_find_after_add_edges_bulk
    (
        uint64_t * const root_of,
        uint64_t * const root_size
    )
    const noexcept;
 
    void update_union_find_after_remove_edge
    (
        const node u,
        const node v,
        uint64_t * const root_of,
        uint64_t * const root_size
    )
    const noexcept;
 
    void update_union_find_after_remove_edges
    (
        const edge_list& edges,
        uint64_t * const root_of,
        uint64_t * const root_size
    )
    const noexcept;
 
    void update_union_find_after_remove_edges_bulk
    (
        uint64_t * const root_of,
        uint64_t * const root_size
    )
    const noexcept;
 
    void update_union_find_before_remove_incident_edges_to(
        const node u,
        uint64_t * const root_of,
        uint64_t * const root_size
    )
    const noexcept;
 
    void copy_full_free_tree(const free_tree& f) noexcept {
        // copy undirected_graph class
        copy_full_undirected_graph(f);
 
        // copy only tree's members
        tree_only_copy(f);
 
        // copy this class' members
    }
    void move_full_free_tree(free_tree&& f) noexcept {
        // move-assign undirected_graph class
        move_full_undirected_graph(std::forward<free_tree>(f));
 
        // move-assign only tree's members
        tree_only_move(std::forward<free_tree>(f));
 
        // move this class' members
    }
 
private:
    using undirected_graph::disjoint_union;
};
 
} // -- namespace graphs
} // -- namespace lal