treebank_feature.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 <cstdint>
 
namespace lal {
namespace io {
 
enum class treebank_feature {
    // STRUCTURAL PROPERTIES
 
    num_nodes,
    second_moment_degree,
    second_moment_degree_in,
    second_moment_degree_out,
    third_moment_degree,
    third_moment_degree_in,
    third_moment_degree_out,
    num_pairs_independent_edges,
    head_initial,
    hubiness,
    mean_hierarchical_distance,
    tree_centre,
    tree_centroid,
    tree_diameter,
 
    // C
 
    num_crossings,
    predicted_num_crossings,
    exp_num_crossings,
    var_num_crossings,
    z_score_num_crossings,
 
    // D
 
    sum_edge_lengths,
    exp_sum_edge_lengths,
    exp_sum_edge_lengths_projective,
    exp_sum_edge_lengths_planar,
    var_sum_edge_lengths,
    z_score_sum_edge_lengths,
    min_sum_edge_lengths,
    min_sum_edge_lengths_planar,
    min_sum_edge_lengths_projective,
    mean_dependency_distance,
 
    // FLUXES
 
    flux_max_weight,
    flux_mean_weight,
    flux_min_weight,
 
    flux_max_left_span,
    flux_mean_left_span,
    flux_min_left_span,
 
    flux_max_right_span,
    flux_mean_right_span,
    flux_min_right_span,
 
    flux_max_size,
    flux_mean_size,
    flux_min_size,
 
    flux_max_RL_ratio,
    flux_mean_RL_ratio,
    flux_min_RL_ratio,
 
    flux_max_WS_ratio,
    flux_mean_WS_ratio,
    flux_min_WS_ratio,
 
    // TYPES OF TREES
 
    tree_type,
 
    syntactic_dependency_structure_class,
 
    /*
     * @brief The last value of the enumeration.
     *
     * <b>This is used for internal purposes only.</b> Do not use this feature.
     */
    __last_value
};
 
static constexpr std::size_t __treebank_feature_size =
    static_cast<std::size_t>(treebank_feature::__last_value);
 
} // -- namespace io
} // -- namespace lal