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