treebank_processor_base.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 <string>
#include <array>
 
// lal includes
#include <lal/io/treebank_feature_type.hpp>
 
namespace lal {
namespace io {
 
class _treebank_processor_base {
public:
    // MODIFIERS
 
    void add_feature(const treebank_feature_type& fs) noexcept
    { m_what_fs[ static_cast<std::size_t>(fs) ] = true; }
    void remove_feature(const treebank_feature_type& fs) noexcept
    { m_what_fs[ static_cast<std::size_t>(fs) ] = false; }
 
    // SETTERS
 
    void set_check_before_process(const bool v) noexcept
    { m_check_before_process = v; }
 
    void clear_features() noexcept
    { std::fill(m_what_fs.begin(), m_what_fs.end(), false); }
 
    void set_separator(const char c) noexcept { m_separator = c; }
    void set_verbosity(const int k) noexcept { m_be_verbose = k; }
    void set_output_header(const bool h) noexcept { m_output_header = h; }
 
    void set_column_name(const treebank_feature_type& tf, const std::string& name)
    noexcept
    {
        m_column_names[static_cast<std::size_t>(tf)] = name;
    }
 
    // GETTERS
 
    [[nodiscard]] bool has_feature(const treebank_feature_type& fs) const noexcept
    { return m_what_fs[ static_cast<std::size_t>(fs) ]; }
 
protected:
    std::array<std::string, __treebank_feature_size> m_column_names;
    std::array<bool, __treebank_feature_size> m_what_fs;
 
    bool m_check_before_process = true;
    char m_separator = '\t';
    bool m_output_header = true;
 
    int m_be_verbose = 0;
 
protected:
    void initialize_column_names() noexcept {
        for (std::size_t i = 0; i < __treebank_feature_size; ++i) {
            m_column_names[i] = treebank_feature_index_to_string(i);
        }
    }
};
 
} // -- namespace io
} // -- namespace lal