tree_generator.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/graphs/free_tree.hpp>
#include <lal/graphs/rooted_tree.hpp>
 
namespace lal {
namespace generate {
 
template <
    class tree_t,
    std::enable_if_t< std::is_base_of_v<graphs::tree, tree_t>, bool > = true
>
class _tree_generator {
private:
    static constexpr bool is_free = std::is_base_of_v<graphs::free_tree, tree_t>;
 
public:
    using generated_tree_t = tree_t;
 
public:
    /* CONSTRUCTORS */
 
    _tree_generator() noexcept = default;
 
    _tree_generator(const uint64_t n) noexcept : m_n(n) { }
    _tree_generator(const _tree_generator& Gen) noexcept = default;
 
    _tree_generator(_tree_generator&& Gen) noexcept = default;
 
    virtual ~_tree_generator() noexcept = default;
 
    /* INITIALIZE */
 
    void init(const uint64_t n) noexcept {
        m_n = n;
        activate_all_postprocessing_actions();
    }
 
    void clear() noexcept { }
 
    /* OPERATORS */
 
    _tree_generator& operator= (const _tree_generator& Gen) = default;
    _tree_generator& operator= (_tree_generator&& Gen) = default;
 
    /* GETTERS */
 
    [[nodiscard]] tree_t get_tree() noexcept
    {
        tree_t t = __get_tree();
 
        // free and rooted trees
        if (m_normalize_tree) {
            t.normalize();
        }
        if (m_calculate_tree_type) {
            t.calculate_tree_type();
        }
 
        // only free trees
        if constexpr (is_free) {
 
        }
 
        // only rooted trees
        if constexpr (not is_free) {
            if (m_calculate_size_subtrees) {
                t.calculate_size_subtrees();
            }
        }
        return t;
    }
 
    /* MODIFIERS */
 
    [[nodiscard]] virtual tree_t yield_tree() noexcept = 0;
 
    void activate_all_postprocessing_actions() noexcept {
        set_normalize_tree(true);
        set_calculate_size_subtrees(true);
        set_calculate_tree_type(true);
    }
 
    void deactivate_all_postprocessing_actions() noexcept {
        set_normalize_tree(false);
        set_calculate_size_subtrees(false);
        set_calculate_tree_type(false);
    }
 
    /* SETTERS */
 
    void set_normalize_tree(const bool v) noexcept {
        m_normalize_tree = v;
    }
 
    void set_calculate_size_subtrees(const bool v) noexcept {
        m_calculate_size_subtrees = v;
    }
 
    void set_calculate_tree_type(const bool v) noexcept {
        m_calculate_tree_type = v;
    }
 
protected:
    [[nodiscard]] virtual tree_t __get_tree() noexcept = 0;
 
protected:
    uint64_t m_n = 0;
 
    bool m_normalize_tree = true;
    bool m_calculate_size_subtrees = true;
    bool m_calculate_tree_type = true;
};
 
} // -- namespace generate
} // -- namespace lal