all_projective_arrangements.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
#include <vector>
 
// lal includes
#include <lal/definitions.hpp>
#include <lal/graphs/rooted_tree.hpp>
#include <lal/graphs/free_tree.hpp>
 
namespace lal {
namespace generate {
 
class all_projective_arrangements {
public:
    /* CONSTRUCTORS */
 
    all_projective_arrangements(const graphs::rooted_tree& T) noexcept;
    all_projective_arrangements(const graphs::free_tree& T, node root) noexcept
        : all_projective_arrangements(graphs::rooted_tree(T, root))
    { }
    all_projective_arrangements(const all_projective_arrangements& Gen) = default;
#ifndef SWIG
    all_projective_arrangements(all_projective_arrangements&& Gen) = default;
#endif
 
    ~all_projective_arrangements() noexcept = default;
 
    /* GETTERS */
 
    inline bool end() const noexcept { return m_reached_end; };
 
    linear_arrangement get_arrangement() const noexcept;
 
    /* MODIFIERS */
 
    void next() noexcept;
 
    void reset() noexcept;
 
    inline linear_arrangement yield_arrangement() noexcept {
        // yes, a copy...
        const linear_arrangement arr = get_arrangement();
        next();
        return arr;
    }
 
private:
    const graphs::rooted_tree& m_rT;
    std::vector<std::vector<node>> m_intervals;
    bool m_reached_end = false;
 
private:
    void initialise_intervals_tree() noexcept;
    void initialise_interval_node(node u) noexcept;
};
 
} // -- namespace generate
} // -- namespace lal