head_vector.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 <optional>
#include <string>
 
// lal includes
#include <lal/graphs/free_tree.hpp>
#include <lal/graphs/rooted_tree.hpp>
 
namespace lal {
namespace io {
 
// **DEVELOPER NOTE**
// These functions were not implemented as a templated function in this header
// file so as to avoid including <filesystem> and <ifstream> in this header.
 
// **DEVELOPER NOTE**
// These function's documentation has to be updated manually in the io.i
// interface file.
 
[[nodiscard]] std::optional<graphs::free_tree> read_head_vector_free_tree
(
    const std::string& filename,
    const bool norm = true,
    const bool check_norm = true
)
noexcept;
[[nodiscard]] std::optional<graphs::rooted_tree> read_head_vector_rooted_tree
(
    const std::string& filename,
    const bool norm = true,
    const bool check_norm = true
)
noexcept;
 
template <
    class tree_t,
    std::enable_if_t< std::is_base_of_v<graphs::tree, tree_t>, bool > = true
>
[[nodiscard]] inline std::optional<tree_t> read_head_vector
(
    const std::string& filename,
    const bool norm = true,
    const bool check_norm = true
)
noexcept
{
    if constexpr (std::is_same_v<graphs::free_tree, tree_t>) {
        return read_head_vector_free_tree(filename, norm, check_norm);
    }
    else if constexpr (std::is_same_v<graphs::rooted_tree, tree_t>) {
        return read_head_vector_rooted_tree(filename, norm, check_norm);
    }
}
 
} // -- namespace io
} // -- namespace lal