chunk_sequence.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
 
// C++ includes
#if defined DEBUG
#include <cassert>
#endif
 
// lal includes
#include <lal/basic_types.hpp>
#include <lal/linarr/chunking/chunk.hpp>
#include <lal/detail/array.hpp>
 
namespace lal {
namespace linarr {
 
class chunk_sequence {
public:
    typedef typename std::vector<chunk>::const_iterator const_iterator;
    typedef typename std::vector<chunk>::iterator iterator;
 
public:
 
    void init(const std::size_t n) noexcept {
        m_from_node_to_chunk.resize(n, n + 1);
    }
 
    [[nodiscard]] const chunk& operator[] (const std::size_t i) const noexcept {
#if defined DEBUG
        assert(i < size());
#endif
        return m_chunks[i];
    }
 
    [[nodiscard]] chunk& operator[] (const std::size_t i) noexcept {
#if defined DEBUG
        assert(i < size());
#endif
        return m_chunks[i];
    }
 
    /* MODIFIERS */
 
    void push_chunk() noexcept {
        m_chunks.push_back({});
    }
 
    void push_chunk(const node u) noexcept {
        push_chunk();
        m_chunks.back().add_node(u);
    }
 
    /* SETTERS */
 
    void set_chunk_index(const node u, const std::size_t i) noexcept {
#if defined DEBUG
        assert(u < m_from_node_to_chunk.size());
#endif
        m_from_node_to_chunk[u] = i;
    }
 
    /* GETTERS */
 
    [[nodiscard]] std::size_t size() const noexcept {
        return m_chunks.size();
    }
 
    [[nodiscard]] std::size_t get_chunk_index(const node u) const noexcept {
#if defined DEBUG
        assert(u < m_from_node_to_chunk.size());
#endif
        return m_from_node_to_chunk[u];
    }
 
    [[nodiscard]] const_iterator begin() const noexcept
    { return m_chunks.begin(); }
    [[nodiscard]] iterator begin() noexcept
    { return m_chunks.begin(); }
 
    [[nodiscard]] const_iterator end() const noexcept
    { return m_chunks.end(); }
    [[nodiscard]] iterator end() noexcept
    { return m_chunks.end(); }
 
    [[nodiscard]] const std::vector<chunk>& get_chunks() const noexcept
    { return m_chunks; }
 
private:
    std::vector<chunk> m_chunks;
    detail::array<std::size_t> m_from_node_to_chunk;
};
 
} // -- namespace linarr
} // -- namespace lal