Text map entry. More...

#include <TextMap.hpp>

Properties
std::size_t	p {}
	The position of the annotated part inside the text. More...

std::size_t	l {}
	The length of the annotated part inside the text. More...

std::string	value
	Value of the annotation. More...

Construction
	TextMapEntry ()=default
	Default constructor. More...

	TextMapEntry (std::size_t setPos, std::size_t setLength)
	Constructor creating an empty annotation. More...

	TextMapEntry (std::size_t setPos, std::size_t setLength, const std::string &setValue)
	Constructor creating a non-empty annotation. More...

Swap
void	swap (TextMapEntry &other)
	Swaps the text map entry with another. More...

Cleanup
void	free ()
	Resets its properties to their default values and frees the memory used by the entry. More...

String Conversion
std::string	str () const
	Converts the text map entry into a string. More...

Static Access Functions
static std::size_t &	pos (TextMapEntry &entry)
	Gets a reference to the position of a text map entry. More...

static std::size_t &	pos (std::pair< std::size_t, std::size_t > &entry)
	Gets a reference to the position of a sentence map entry. More...

static std::size_t	pos (const TextMapEntry &entry)
	Gets the position of a text map entry. More...

static std::size_t	pos (const std::pair< std::size_t, std::size_t > &entry)
	Gets the position of a sentence map entry. More...

template<typename T >
static std::size_t	end (const T &entry)
	Gets the end of a map entry. More...

static std::size_t &	length (TextMapEntry &entry)
	Gets a reference to the length of a text map entry. More...

static std::size_t &	length (std::pair< std::size_t, std::size_t > &entry)
	Gets a reference to the length of a sentence map entry. More...

static std::size_t	length (const TextMapEntry &entry)
	Gets the length of a text map entry. More...

static std::size_t	length (const std::pair< std::size_t, std::size_t > &entry)
	Gets the length of a sentence map entry. More...

Detailed Description

Text map entry.

A text map entry annotates one part of a text, defined by its position and length, with a string value.

Constructor & Destructor Documentation

◆ TextMapEntry() [1/3]

crawlservpp::Struct::TextMapEntry::TextMapEntry ( )

default

Default constructor.

◆ TextMapEntry() [2/3]

crawlservpp::Struct::TextMapEntry::TextMapEntry	(	std::size_t	setPos,
		std::size_t	setLength
	)

inline

Constructor creating an empty annotation.

Parameters

setPos	The position of the annotated part of the text, starting with zero at the beginning of the text.
setLength	The length of the annotated part of the text.

◆ TextMapEntry() [3/3]

crawlservpp::Struct::TextMapEntry::TextMapEntry	(	std::size_t	setPos,
		std::size_t	setLength,
		const std::string &	setValue
	)

inline

Constructor creating a non-empty annotation.

Parameters

setPos	The position of the annotated part of the text, starting with zero at the beginning of the text.
setLength	The length of the annotated part of the text.
setValue	Const reference to a string containing the value of the annotation.

Member Function Documentation

◆ end()

template<typename T >

static std::size_t crawlservpp::Struct::TextMapEntry::end ( const T & entry )

inlinestatic

Gets the end of a map entry.

Parameters

entry Constant reference to the map entry to get the end of.

Returns: The end of the given entry.

References length(), and pos().

Referenced by crawlservpp::Data::Corpus::clear(), crawlservpp::Data::Corpus::combineTokenized(), crawlservpp::Data::Corpus::copyChunksContinuous(), crawlservpp::Data::Corpus::filterArticles(), crawlservpp::Data::Corpus::filterByDate(), crawlservpp::Data::Corpus::getArticles(), crawlservpp::Data::Corpus::getTokenized(), crawlservpp::Module::Analyzer::Algo::CorpusGenerator::resetAlgo(), crawlservpp::Module::Analyzer::Algo::WordsOverTime::resetAlgo(), crawlservpp::Module::Analyzer::Algo::Assoc::resetAlgo(), crawlservpp::Module::Analyzer::Algo::AssocOverTime::resetAlgo(), crawlservpp::Module::Analyzer::Algo::AllTokens::resetAlgo(), and crawlservpp::Module::Analyzer::Algo::SentimentOverTime::resetAlgo().

◆ free()

void crawlservpp::Struct::TextMapEntry::free ( )

inline

Resets its properties to their default values and frees the memory used by the entry.

References crawlservpp::Helper::Memory::free(), l, and p.

◆ length() [1/4]

static std::size_t& crawlservpp::Struct::TextMapEntry::length ( TextMapEntry & entry )

inlinestatic

Gets a reference to the length of a text map entry.

Parameters

entry Reference to the text map entry to get the length of.

Returns: Reference to the length of the given entry.

References l.

Referenced by crawlservpp::Data::Corpus::clear(), crawlservpp::Data::Corpus::combineContinuous(), crawlservpp::Data::Corpus::combineTokenized(), crawlservpp::Data::Corpus::copyChunksContinuous(), end(), crawlservpp::Data::Corpus::get(), crawlservpp::Data::Corpus::getArticles(), crawlservpp::Data::Corpus::getTokenized(), crawlservpp::Module::Analyzer::Algo::Assoc::resetAlgo(), crawlservpp::Module::Analyzer::Algo::AssocOverTime::resetAlgo(), crawlservpp::Module::Analyzer::Algo::SentimentOverTime::resetAlgo(), and crawlservpp::Module::Analyzer::Algo::TopicModelling::resetAlgo().

◆ length() [2/4]

static std::size_t& crawlservpp::Struct::TextMapEntry::length ( std::pair< std::size_t, std::size_t > & entry )

inlinestatic

Gets a reference to the length of a sentence map entry.

Parameters

entry Reference to the sentence map entry to get the length of.

Returns: Reference to the length of the given entry.

◆ length() [3/4]

static std::size_t crawlservpp::Struct::TextMapEntry::length ( const TextMapEntry & entry )

inlinestatic

Gets the length of a text map entry.

Parameters

entry Constant reference to the text map entry to get the length of.

Returns: The length of the given entry.

References l.

◆ length() [4/4]

static std::size_t crawlservpp::Struct::TextMapEntry::length ( const std::pair< std::size_t, std::size_t > & entry )

inlinestatic

Gets the length of a sentence map entry.

Parameters

entry Constant reference to the sentence map entry to get the length of.

Returns: The length of the given entry.

◆ pos() [1/4]

static std::size_t& crawlservpp::Struct::TextMapEntry::pos ( TextMapEntry & entry )

inlinestatic

Gets a reference to the position of a text map entry.

Parameters

entry Reference to the text map entry to get the position of.

Returns: Reference to the position of the given entry.

References p.

Referenced by crawlservpp::Data::Corpus::clear(), crawlservpp::Data::Corpus::combineContinuous(), crawlservpp::Data::Corpus::combineTokenized(), end(), crawlservpp::Data::Corpus::filterArticles(), crawlservpp::Data::Corpus::filterByDate(), crawlservpp::Data::Corpus::get(), crawlservpp::Data::Corpus::getArticles(), crawlservpp::Data::Corpus::getTokenized(), crawlservpp::Module::Analyzer::Algo::WordsOverTime::resetAlgo(), crawlservpp::Module::Analyzer::Algo::Assoc::resetAlgo(), crawlservpp::Module::Analyzer::Algo::AssocOverTime::resetAlgo(), crawlservpp::Module::Analyzer::Algo::AllTokens::resetAlgo(), crawlservpp::Module::Analyzer::Algo::SentimentOverTime::resetAlgo(), and crawlservpp::Module::Analyzer::Algo::TopicModelling::resetAlgo().

◆ pos() [2/4]

static std::size_t& crawlservpp::Struct::TextMapEntry::pos ( std::pair< std::size_t, std::size_t > & entry )

inlinestatic

Gets a reference to the position of a sentence map entry.

Parameters

entry Reference to the sentence map entry to get the position of.

Returns: Reference to the position of the given entry.

◆ pos() [3/4]

static std::size_t crawlservpp::Struct::TextMapEntry::pos ( const TextMapEntry & entry )

inlinestatic

Gets the position of a text map entry.

Parameters

entry Constant reference to the text map entry to get the position of.

Returns: The position of the given entry.

References p.

◆ pos() [4/4]

static std::size_t crawlservpp::Struct::TextMapEntry::pos ( const std::pair< std::size_t, std::size_t > & entry )

inlinestatic

Gets the position of a sentence map entry.

Parameters

entry Constant reference to the sentence map entry to get the position of.

Returns: The position of the given entry.

◆ str()

std::string crawlservpp::Struct::TextMapEntry::str ( ) const

inline

Converts the text map entry into a string.

Returns: String representing the text map entry – containing its position, length, and value.

References l, p, and value.

◆ swap()

void crawlservpp::Struct::TextMapEntry::swap ( TextMapEntry & other )

inline

Swaps the text map entry with another.

Parameters

other Reference to the other text map entry to be swapped with.

Member Data Documentation

◆ l

std::size_t crawlservpp::Struct::TextMapEntry::l {}

The length of the annotated part inside the text.

Referenced by free(), length(), and str().

◆ p

std::size_t crawlservpp::Struct::TextMapEntry::p {}

The position of the annotated part inside the text.

Zero indicates the very beginning of the text.

Referenced by free(), pos(), and str().

◆ value

std::string crawlservpp::Struct::TextMapEntry::value

Value of the annotation.

For example, an article ID or a date for an entry of the article or date map belonging to a text corpus.

Referenced by crawlservpp::Data::Corpus::clear(), crawlservpp::Data::Corpus::create(), crawlservpp::Module::Analyzer::Algo::Assoc::resetAlgo(), crawlservpp::Module::Analyzer::Algo::AssocOverTime::resetAlgo(), crawlservpp::Module::Analyzer::Algo::AllTokens::resetAlgo(), and str().

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

Struct/TextMap.hpp

Properties

Construction

Swap

Cleanup

String Conversion

Static Access Functions

Detailed Description

Constructor & Destructor Documentation

◆ TextMapEntry() [1/3]

◆ TextMapEntry() [2/3]

◆ TextMapEntry() [3/3]

Member Function Documentation

◆ end()

◆ free()

◆ length() [1/4]

◆ length() [2/4]

◆ length() [3/4]

◆ length() [4/4]

◆ pos() [1/4]

◆ pos() [2/4]

◆ pos() [3/4]

◆ pos() [4/4]

◆ str()

◆ swap()

Member Data Documentation

◆ l

◆ p

◆ value