Dmin.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/graphs/free_tree.hpp>
#include <lal/graphs/rooted_tree.hpp>
#include <lal/properties/bipartite_graph_coloring.hpp>
#include <lal/linarr/D/algorithms_Dmin_projective.hpp>
#include <lal/linarr/D/algorithms_Dmin_planar.hpp>
#include <lal/linarr/D/algorithms_Dmin.hpp>
 
namespace lal {
namespace linarr {
 
[[nodiscard]] std::pair<uint64_t, linear_arrangement> min_sum_edge_lengths
(const graphs::free_tree& t, const algorithms_Dmin& a = algorithms_Dmin::Shiloach)
noexcept;
[[nodiscard]] inline std::pair<uint64_t, linear_arrangement> min_sum_edge_lengths
(const graphs::rooted_tree& t, const algorithms_Dmin& a = algorithms_Dmin::Shiloach)
noexcept
{
    return min_sum_edge_lengths(t.to_free_tree(), a);
}
 
[[nodiscard]] std::pair<uint64_t, linear_arrangement> min_sum_edge_lengths_bipartite
(const graphs::free_tree& t, const properties::bipartite_graph_coloring& c)
noexcept;
 
[[nodiscard]] std::pair<uint64_t, linear_arrangement> min_sum_edge_lengths_bipartite
(const graphs::free_tree& t)
noexcept;
 
[[nodiscard]] std::pair<uint64_t, linear_arrangement> min_sum_edge_lengths_planar
(
    const graphs::free_tree& t,
    const algorithms_Dmin_planar& a = algorithms_Dmin_planar::AlemanyEstebanFerrer
)
noexcept;
[[nodiscard]] inline std::pair<uint64_t, linear_arrangement> min_sum_edge_lengths_planar
(
    const graphs::rooted_tree& t,
    const algorithms_Dmin_planar& a = algorithms_Dmin_planar::AlemanyEstebanFerrer
)
noexcept
{
    return min_sum_edge_lengths_planar(t.to_free_tree(), a);
}
 
[[nodiscard]] std::pair<uint64_t, linear_arrangement> min_sum_edge_lengths_projective
(
    const graphs::rooted_tree& t,
    const algorithms_Dmin_projective& a = algorithms_Dmin_projective::AlemanyEstebanFerrer
)
noexcept;
 
} // -- namespace linarr
} // -- namespace lal