lal::io::treebank_processor Class Reference

Automatic processing of treebank files. More...

#include <treebank_processor.hpp>

Inheritance diagram for lal::io::treebank_processor:

Public Member Functions
treebank_file_error	init (const std::string &treebank_input_file, const std::string &output_file, const std::string &treebank_id="") noexcept
	Initialize the processor with a new collection.
treebank_file_error	process () noexcept
	Process the treebank file.
void	add_feature (const treebank_feature_type &fs) noexcept
	Adds a feature to the processor.
void	remove_feature (const treebank_feature_type &fs) noexcept
	Removes a feature from the processor.
void	set_check_before_process (const bool v) noexcept
	Should the treebank file or collection be checked for errors prior to processing?
void	clear_features () noexcept
	Clear the features in the processor.
void	set_separator (const char c) noexcept
	Sets the separator character.
void	set_verbosity (const int k) noexcept
	Sets the level of verbosity of the process methods.
void	set_output_header (const bool h) noexcept
	Output a hedaer for the treebank result file.
void	set_column_name (const treebank_feature_type &tf, const std::string &name) noexcept
	Sets a custom name for the column corresponding to a given feature.
bool	has_feature (const treebank_feature_type &fs) const noexcept
	Is a given feature to be calculated?

Protected Member Functions
void	initialize_column_names () noexcept
	Initializes column names m_column_names.

Protected Attributes
std::array< std::string, __treebank_feature_size >	m_column_names
	String for each column.
std::array< bool, __treebank_feature_size >	m_what_fs
	The list of features to be computed.
bool	m_check_before_process = true
	Process the treebank file or collection prior to processing.
char	m_separator = '\t'
	Character used as separator.
bool	m_output_header = true
	Output a header for each file.
int	m_be_verbose = 0
	The verbosity of the processor.

Private Member Functions
template<class TREE , class OUT_STREAM >
void	process_tree (const TREE &rT, double *const props, char *const prop_set, OUT_STREAM &out_lab_file) noexcept
	Process a single tree in a treebank.
template<class OUT_STREAM >
void	output_tree_type_header (OUT_STREAM &out_lab_file) const noexcept
	Output the header for the tree types.
template<class OUT_STREAM >
void	output_syndepstruct_type_header (OUT_STREAM &out_lab_file) const noexcept
	Output the header for the tree types.
template<class TREE_TYPE , class OUT_STREAM >
void	output_tree_type_values (TREE_TYPE &t, OUT_STREAM &out_lab_file) const noexcept
	Output the values for the tree types.
template<class TREE_TYPE , class OUT_STREAM >
void	output_syndepstruct_type_values (const TREE_TYPE &t, const uint64_t C, OUT_STREAM &out_lab_file) const noexcept
	Output the values for the syntactic dependency tree types.

Private Attributes
std::string	m_treebank_filename = "none"
	File containing the list of languages and their treebanks.
std::string	m_output_file = "none"
	Output directory.
std::string	m_treebank_id = ""
	Treebank identifier.

Detailed Description

Automatic processing of treebank files.

This class, the objects of which will be referred to as the "processors", has the goal to ease the processing a whole treebank collection and produce data for a fixed set of features available in the library. See the enumeration lal::io::treebank_feature_type for details on the features available.

This class is meant to process a single treebank file only (see Treebank for further details on treebank files).

Every processor must be initialized prior to processing the treebank file. This is done via method init, which requires the path to the treebank file and the name of the output file (the treebank result) where the results are going to be stored. It also requires a Boolean value indicating whether all (or none) of the features should be used. Processing a treebank file with this class will produce a single file, with as many columns as features added to the processor. The columns are separated with a separating character (see method set_separator); this file will contain a header only if method set_output_header has been called with true). Progress and error messages can be controlled via method set_verbosity.

When initialized, features can be added to or removed from the processor: when the number of features to calculate is low, it can be initialized with no features, and then be added some via method add_feature. Conversely, if the number of features is high, but not all features are needed, a processer can be initialized with all features, and then be removed some of them via method remove_feature.

Finally, the treebank file is processed via method process. This method returns an error, if any, via lal::io::treebank_file_error.

The usage of this class is a lot simpler than that of class treebank_collection_reader. For example:

treebank_processor tbproc;
// initialize the processor without features (remmeber to check for errors)
tbproc.init(treebank_input_file, result_filename, "Book_1");
tbproc.add_feature(lal::io::treebank_feature_type::num_crossings);
tbproc.add_feature(lal::io::treebank_feature_type::var_num_crossings);
tbproc.process();
// it is advisable to check for errors

Member Function Documentation

add_feature()

void lal::io::_treebank_processor_base::add_feature ( const treebank_feature_type & fs )

inlinenoexceptinherited

Adds a feature to the processor.

Parameters

fs	Feature to be added.

has_feature()

bool lal::io::_treebank_processor_base::has_feature ( const treebank_feature_type & fs ) const

inlinenodiscardnoexceptinherited

Is a given feature to be calculated?

Parameters

fs	The feature being queried.

Returns

True or False depending on whether the feature was added or removed.

init()

treebank_file_error lal::io::treebank_processor::init ( const std::string & treebank_input_file, const std::string & output_file, const std::string & treebank_id = "" )

noexcept

Initialize the processor with a new collection.

Parameters

treebank_input_file	File listing all the treebanks.
output_file	File where the results are to be stored.
treebank_id	A nickname for this treebank (for example, an ISO code).

Returns

The type of the error, if any. The list of errors that this method can return is:

• lal::io::treebank_file_error_type::treebank_file_does_not_exist

process()

treebank_file_error lal::io::treebank_processor::process ( )

nodiscardnoexcept

Process the treebank file.

This method produces the information as explained in this class' description. However, it may fail to do so. In this case it will return a value different from lal::io::treebank_file_error_type::no_error.

This function uses attributes m_separator, m_output_header to format the output data. It also outputs the current progress if m_be_verbose is set to true.

Returns

The type of the error, if any. The list of errors that this method can return is:

• lal::io::treebank_file_error_type::no_features
• lal::io::treebank_file_error_type::output_file_could_not_be_opened
• lal::io::treebank_file_error_type::treebank_file_could_not_be_opened

Precondition

Initialisation did not return any errors.

remove_feature()

void lal::io::_treebank_processor_base::remove_feature ( const treebank_feature_type & fs )

inlinenoexceptinherited

Removes a feature from the processor.

Parameters

fs	Feature to be removed.

set_column_name()

void lal::io::_treebank_processor_base::set_column_name ( const treebank_feature_type & tf, const std::string & name )

inlinenoexceptinherited

Sets a custom name for the column corresponding to a given feature.

This does not work for features

• lal::io::treebank_feature_type::tree_type
• lal::io::treebank_feature_type::syntactic_dependency_tree_class

  Parameters

  tf	Feature whose column name is to be modified.
  name	Custom name for the column.

set_output_header()

void lal::io::_treebank_processor_base::set_output_header ( const bool h )

inlinenoexceptinherited

Output a hedaer for the treebank result file.

Default is true.

Parameters

h	Output header or not.

set_separator()

void lal::io::_treebank_processor_base::set_separator ( const char c )

inlinenoexceptinherited

Sets the separator character.

The default seprator is a tabulator character '\t'.

Parameters

c	The separator character.

set_verbosity()

void lal::io::_treebank_processor_base::set_verbosity ( const int k )

inlinenoexceptinherited

Sets the level of verbosity of the process methods.

Default is 0 (i.e., no verbosity at all). Verbosity is classified by levels:

• Level 1: outputs progress messages.
• Level 2: outputs error messages.

  Parameters

  k	Verbosity level.

Member Data Documentation

m_be_verbose

int lal::io::_treebank_processor_base::m_be_verbose = 0

protectedinherited

The verbosity of the processor.

When set to a value greater than or equal to 1, method process will output progress messages.

---

The documentation for this class was generated from the following file:

• lal/io/treebank_processor.hpp