C.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/linear_arrangement.hpp>
#include <lal/graphs/directed_graph.hpp>
#include <lal/graphs/undirected_graph.hpp>
#include <lal/linarr/C/algorithms_C.hpp>
#include <lal/numeric/rational.hpp>
 
namespace lal {
namespace linarr {
 
[[nodiscard]] uint64_t num_crossings
(const graphs::directed_graph& G, const algorithms_C& A = algorithms_C::ladder)
noexcept;
[[nodiscard]] uint64_t num_crossings
(const graphs::undirected_graph& G, const algorithms_C& A = algorithms_C::ladder)
noexcept;
 
[[nodiscard]] uint64_t num_crossings
(
    const graphs::directed_graph& G,
    const linear_arrangement& arr,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
uint64_t num_crossings(
    const graphs::undirected_graph& G,
    const linear_arrangement& arr,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
 
[[nodiscard]] std::vector<uint64_t> num_crossings_list
(
    const graphs::directed_graph& G,
    const std::vector<linear_arrangement>& arrs,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
[[nodiscard]] std::vector<uint64_t> num_crossings_list
(
    const graphs::undirected_graph& G,
    const std::vector<linear_arrangement>& arrs,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
 
[[nodiscard]] uint64_t is_num_crossings_lesseq_than
(
    const graphs::directed_graph& G,
    const uint64_t upper_bound,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
[[nodiscard]] uint64_t is_num_crossings_lesseq_than
(
    const graphs::undirected_graph& G,
    const uint64_t upper_bound,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
 
[[nodiscard]] uint64_t is_num_crossings_lesseq_than
(
    const graphs::directed_graph& G,
    const linear_arrangement& arr,
    const uint64_t upper_bound,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
[[nodiscard]] uint64_t is_num_crossings_lesseq_than
(
    const graphs::undirected_graph& G,
    const linear_arrangement& arr,
    const uint64_t upper_bound,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
 
[[nodiscard]] std::vector<uint64_t> is_num_crossings_lesseq_than_list
(
    const graphs::directed_graph& G,
    const std::vector<linear_arrangement>& arrs,
    const uint64_t upper_bound,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
[[nodiscard]] std::vector<uint64_t> is_num_crossings_lesseq_than_list
(
    const graphs::undirected_graph& G,
    const std::vector<linear_arrangement>& arrs,
    const uint64_t upper_bound,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
 
[[nodiscard]] std::vector<uint64_t> is_num_crossings_lesseq_than_list
(
    const graphs::directed_graph& G,
    const std::vector<linear_arrangement>& arrs,
    const std::vector<uint64_t>& upper_bounds,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
[[nodiscard]] std::vector<uint64_t> is_num_crossings_lesseq_than_list
(
    const graphs::undirected_graph& G,
    const std::vector<linear_arrangement>& arrs,
    const std::vector<uint64_t>& upper_bounds,
    const algorithms_C& A = algorithms_C::ladder
)
noexcept;
 
/* ---------------------------------------- */
/* APPROXIMATION OF THE NUMBER OF CROSSINGS */
 
[[nodiscard]] numeric::rational predicted_num_crossings_rational
(const graphs::undirected_graph& g, const linear_arrangement& arr = {}) noexcept;
 
numeric::rational predicted_num_crossings_rational
(const graphs::directed_graph& g, const linear_arrangement& arr = {}) noexcept;
 
[[nodiscard]] double predicted_num_crossings
(const graphs::undirected_graph& g, const linear_arrangement& arr = {}) noexcept;
 
[[nodiscard]] double predicted_num_crossings
(const graphs::directed_graph& g, const linear_arrangement& arr = {}) noexcept;
 
} // -- namespace linarr
} // -- namespace lal