dependency_flux.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/numeric/rational.hpp>
#include <lal/graphs/rooted_tree.hpp>
#include <lal/graphs/free_tree.hpp>
 
namespace lal {
namespace linarr {
 
class dependency_flux {
public:
 
    // GETTERS
 
    [[nodiscard]] uint64_t get_left_span() const noexcept { return m_left_span;; }
    [[nodiscard]] uint64_t get_right_span() const noexcept { return m_right_span; }
    [[nodiscard]] uint64_t get_size() const noexcept { return m_dependencies.size(); }
    [[nodiscard]] uint64_t get_weight() const noexcept { return m_weight; }
 
    [[nodiscard]] uint64_t& get_left_span() noexcept { return m_left_span;; }
    [[nodiscard]] uint64_t& get_right_span() noexcept { return m_right_span; }
    [[nodiscard]] uint64_t& get_weight() noexcept { return m_weight; }
 
    [[nodiscard]] const std::vector<edge>& get_dependencies() const noexcept
    { return m_dependencies; }
 
    [[nodiscard]] numeric::rational get_RL_ratio_rational() const noexcept
    { return numeric::rational(m_right_span, m_left_span); }
    [[nodiscard]] double get_RL_ratio() const noexcept
    { return get_RL_ratio_rational().to_double(); }
 
    [[nodiscard]] numeric::rational get_WS_ratio_rational() const noexcept
    { return numeric::rational(m_weight, m_dependencies.size()); }
    [[nodiscard]] double get_WS_ratio() const noexcept
    { return get_WS_ratio_rational().to_double(); }
 
    // SETTERS
 
    void set_left_span(const uint64_t ls) noexcept { m_left_span = ls; }
    void set_right_span(const uint64_t rs) noexcept { m_right_span = rs; }
    void set_weight(const uint64_t w) noexcept { m_weight = w; }
 
    void set_dependencies(const std::vector<edge>& deps) noexcept
    { m_dependencies = deps; }
 
    void set_dependencies(std::vector<edge>&& deps) noexcept
    { m_dependencies = std::move(deps); }
 
private:
    uint64_t m_left_span = 0;
    uint64_t m_right_span = 0;
    std::vector<edge> m_dependencies;
    uint64_t m_weight = 0;
};
 
} // -- namespace linarr
} // -- namespace lal