graph.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
#include <vector>
 
// lal includes
#include <lal/basic_types.hpp>
 
namespace lal {
namespace graphs {
 
class graph {
public:
    /* CONSTRUCTORS */
 
    graph() noexcept { }
    graph(const uint64_t n) noexcept {
        _init(n);
    }
 
    graph(const graph& g) noexcept {
        copy_full_graph(g);
    }
 
    graph(graph&& g) noexcept {
        move_full_graph(std::forward<graph>(g));
    }
 
    virtual ~graph() noexcept { }
 
    /* OPERATORS */
 
    graph& operator= (const graph& g) noexcept {
        copy_full_graph(g);
        return *this;
    }
 
    graph& operator= (graph&& g) noexcept {
        move_full_graph(std::forward<graph>(g));
        return *this;
    }
 
    /* MODIFIERS */
 
    virtual void init(const uint64_t n) noexcept;
    virtual void clear() noexcept;
 
    virtual void normalize() noexcept;
 
    virtual bool check_normalized() noexcept;
 
    virtual void finish_bulk_add(const bool norm = true, const bool check = true) noexcept = 0;
 
    virtual void finish_bulk_remove(const bool norm = true, const bool check = true) noexcept = 0;
 
    /* SETTERS */
 
    void set_normalized(const bool v = true) noexcept {
        m_is_normalized = v;
    }
 
    /* GETTERS */
 
    [[nodiscard]] virtual std::vector<edge_pair> get_Q() const noexcept = 0;
 
    [[nodiscard]] bool has_node(const node u) const noexcept { return u < get_num_nodes(); }
 
    [[nodiscard]] virtual bool has_edge(const node u, const node v) const = 0;
 
    [[nodiscard]] uint64_t get_num_nodes() const noexcept
    { return m_adjacency_list.size(); }
 
    [[nodiscard]] uint64_t get_num_edges() const noexcept { return m_num_edges; }
 
    [[nodiscard]] virtual std::vector<edge> get_edges() const noexcept = 0;
 
    [[nodiscard]] bool is_normalized() const noexcept { return m_is_normalized; }
 
    [[nodiscard]] virtual bool is_directed() const noexcept = 0;
    [[nodiscard]] virtual bool is_undirected() const noexcept = 0;
 
protected:
    std::vector<neighbourhood> m_adjacency_list;
    uint64_t m_num_edges = 0;
    bool m_is_normalized = true;
 
protected:
    virtual void _init(const uint64_t n) noexcept {
        m_num_edges = 0;
        m_is_normalized = true;
        m_adjacency_list.resize(n);
    }
    virtual void _clear() noexcept {
        m_num_edges = 0;
        m_is_normalized = true;
        m_adjacency_list.clear();
    }
 
    void copy_full_graph(const graph& g) noexcept {
        m_adjacency_list = g.m_adjacency_list;
        m_num_edges = g.m_num_edges;
        m_is_normalized = g.m_is_normalized;
    }
    void move_full_graph(graph&& g) noexcept {
        m_adjacency_list = std::move(g.m_adjacency_list);
        m_num_edges = std::move(g.m_num_edges);
        m_is_normalized = std::move(g.m_is_normalized);
 
        g.m_num_edges = 0;
        g.m_is_normalized = false;
    }
 
    void __add_node() noexcept {
        m_adjacency_list.emplace_back();
    }
 
    void __disjoint_union(const graph& g) noexcept;
 
    virtual void actions_after_add_edge(const node u, const node v) noexcept;
 
    virtual void actions_after_add_edges(const edge_list& e) noexcept;
 
    virtual void actions_after_add_edges_bulk() noexcept;
 
    virtual void actions_after_remove_edge(const node u, const node v) noexcept;
 
    virtual void actions_after_remove_edges(const edge_list& e) noexcept;
 
    virtual void actions_after_remove_edges_bulk() noexcept;
 
    virtual void actions_before_remove_edges_incident_to(const node u) noexcept;
 
    virtual void actions_after_remove_node(const node u) noexcept;
 
    void normalize_after_edge_addition(const bool norm, const bool check) noexcept;
    void normalize_after_edge_removal(const bool norm, const bool check) noexcept;
};
 
} // -- namespace graphs
} // -- namespace lal