graph.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>
 
namespace lal {
namespace graphs {
 
class graph {
public:
    /* CONSTRUCTORS */
 
    graph() noexcept { }
    graph(uint32_t n) noexcept {
        _init(n);
    }
    graph(const graph& g) noexcept {
        copy_full_graph(g);
    }
#ifndef SWIG
    graph(graph&& g) noexcept {
        move_full_graph(std::move(g));
    }
#endif
    virtual ~graph() noexcept { }
 
    /* OPERATORS */
 
#ifndef SWIG
    graph& operator= (const graph& g) noexcept {
        copy_full_graph(g);
        return *this;
    }
    graph& operator= (graph&& g) noexcept {
        move_full_graph(std::move(g));
        return *this;
    }
#endif
 
    /* MODIFIERS */
 
    virtual void init(uint32_t n) noexcept;
    virtual void clear() noexcept;
 
    virtual void normalise() noexcept;
 
    virtual bool check_normalised() noexcept;
 
    virtual void finish_bulk_add(bool norm = true, bool check = true) noexcept = 0;
 
    /* SETTERS */
 
    inline void set_normalised(bool v = true) noexcept { m_normalised = v; }
 
    /* GETTERS */
 
    virtual std::vector<edge_pair> get_Q() const noexcept = 0;
 
    inline bool has_node(node u) const noexcept { return u < get_num_nodes(); }
 
    virtual bool has_edge(node u, node v) const = 0;
 
    inline uint32_t get_num_nodes() const noexcept
    { return static_cast<uint32_t>(m_adjacency_list.size()); }
 
    inline uint32_t get_num_edges() const noexcept { return m_num_edges; }
 
    virtual std::vector<edge> get_edges() const noexcept = 0;
 
    inline bool is_normalised() const noexcept { return m_normalised; }
 
    virtual bool is_directed() const noexcept = 0;
    virtual bool is_undirected() const noexcept = 0;
 
protected:
    std::vector<neighbourhood> m_adjacency_list;
    uint32_t m_num_edges = 0;
    bool m_normalised = true;
 
protected:
    virtual void _init(uint32_t n) noexcept;
    virtual void _clear() noexcept;
 
    void copy_full_graph(const graph& g) noexcept;
    void move_full_graph(graph&& g) noexcept;
 
    void __disjoint_union(const graph& g) noexcept;
 
    virtual void extra_work_per_edge_add(node u, node v) noexcept;
    virtual void extra_work_per_edge_remove(node u, node v) noexcept;
    void normalise_after_add(bool norm, bool check) noexcept;
    void normalise_after_remove(bool norm, bool check) noexcept;
};
 
} // -- namespace graphs
} // -- namespace lal