all_ulab_rooted_trees.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/rooted_tree.hpp>
#include <lal/generate/tree_generator.hpp>
#include <lal/detail/array.hpp>
 
namespace lal {
namespace generate {
 
class all_ulab_rooted_trees : public _tree_generator<graphs::rooted_tree> {
public:
    /* CONSTRUCTORS */
 
    all_ulab_rooted_trees() noexcept : _tree_generator<graphs::rooted_tree>()
    { }
 
    all_ulab_rooted_trees(const uint64_t n) noexcept {
        init(n);
    }
 
    all_ulab_rooted_trees(const all_ulab_rooted_trees& Gen) noexcept = default;
 
    all_ulab_rooted_trees(all_ulab_rooted_trees&& Gen) noexcept = default;
 
    ~all_ulab_rooted_trees() noexcept = default;
 
    all_ulab_rooted_trees& operator= (const all_ulab_rooted_trees& g) noexcept = default;
    all_ulab_rooted_trees& operator= (all_ulab_rooted_trees&& g) noexcept = default;
 
    /* INITIALIZE */
 
    void init(const uint64_t n) noexcept {
        _tree_generator::init(n);
        // resize the memory
        m_save.resize(m_n + 1);
        m_prev.resize(m_n + 1);
        m_L.resize(m_n + 1);
        // reset the state of the generator
        reset();
    }
 
    void clear() noexcept {
        _tree_generator::clear();
        m_save.clear();
        m_prev.clear();
        m_L.clear();
    }
 
    /* GETTERS */
 
    [[nodiscard]] bool end() const noexcept { return m_reached_end; }
 
    /* MODIFIERS */
 
    void next() noexcept;
 
    void reset() noexcept {
        __reset();
        next();
    }
 
    [[nodiscard]] graphs::rooted_tree yield_tree() noexcept {
        const auto t = get_tree();
        next();
        return t;
    }
 
protected:
    [[nodiscard]] graphs::rooted_tree __get_tree() noexcept;
 
    void __reset() noexcept;
 
private:
    bool m_is_last = false;
    bool m_is_first = false;
    bool m_reached_end = false;
 
    uint64_t m_p = 0;
    detail::array<node> m_save;
    detail::array<node> m_prev;
    detail::array<node> m_L;
};
 
} // -- namespace generate
} // -- namespace lal