aitools::invertedindex::Vocabulary Class Reference

#include <Vocabulary.hpp>

Public Types
typedef std::map< std::string, uint64_t >	tree_map_t
typedef std::tr1::unordered_map < std::string, uint64_t >	hash_map_t
typedef hash_map_t::const_iterator	const_iterator
typedef hash_map_t::iterator	iterator
Public Member Functions
	Vocabulary ()
	Vocabulary (const bfs::path &path) throw (std::invalid_argument)
	Vocabulary (const Vocabulary &vocabulary)
	~Vocabulary ()
void	accumulate (const std::string &word, uint64_t frequency=1)
const_iterator	begin () const
iterator	begin ()
void	clear ()
bool	contains (const std::string &word) const
const_iterator	end () const
iterator	end ()
const_iterator	find (const std::string &word) const
iterator	find (const std::string &word)
uint64_t	frequency (const std::string &word) const
void	get_words (std::vector< std::string > &words) const
bool	insert (const std::string &word, uint64_t frequency=0)
bool	is_empty () const
void	load (const bfs::path &file) throw (std::invalid_argument)
void	save (const bfs::path &file) throw (std::invalid_argument)
size_t	size () const
Static Public Attributes
static const char	delim = '\t'
static const char	newline = '\n'
Private Attributes
hash_map_t	hash_map_

Detailed Description

A class that represents a vocabulary. The vocabulary is case sensitive.

Author:: martin.trenkmann@uni-weimar.de

Created on Jun 22, 2008

Id: Vocabulary.hpp,v 1.3 2010/06/25 15:04:10 trenkman Exp

Definition at line 28 of file Vocabulary.hpp.

Member Typedef Documentation

typedef hash_map_t::const_iterator aitools::invertedindex::Vocabulary::const_iterator

Defines the iterator type to browse the vocabulary read-only.

Definition at line 51 of file Vocabulary.hpp.

typedef std::tr1::unordered_map<std::string, uint64_t> aitools::invertedindex::Vocabulary::hash_map_t

Defines the internal hash-map-based vocabulary type. This map is unsorted, it is used to store the internal vocabulary permanently and to provide fast access on it.

Definition at line 46 of file Vocabulary.hpp.

typedef hash_map_t::iterator aitools::invertedindex::Vocabulary::iterator

Defines the iterator type to browse the vocabulary.

Definition at line 56 of file Vocabulary.hpp.

typedef std::map<std::string, uint64_t> aitools::invertedindex::Vocabulary::tree_map_t

Defines the internal tree-map-based vocabulary type. This map is sorted, it is temporarily used if the order of words is relevant.

See also:: Vocabulary::get_words; Vocabulary::save

Definition at line 39 of file Vocabulary.hpp.

Constructor & Destructor Documentation

aitools::invertedindex::Vocabulary::Vocabulary ( )

The constructor.

Definition at line 4 of file Vocabulary.cpp.

Referenced by Vocabulary().

Here is the caller graph for this function:

aitools::invertedindex::Vocabulary::Vocabulary ( const bfs::path & path ) throw (std::invalid_argument)

The explicit constructor. Loads a vocabulary from file.

Definition at line 7 of file Vocabulary.cpp.

References Vocabulary().

Here is the call graph for this function:

aitools::invertedindex::Vocabulary::Vocabulary ( const Vocabulary & vocabulary )

The copy constructor.

Definition at line 12 of file Vocabulary.cpp.

aitools::invertedindex::Vocabulary::~Vocabulary ( )

The destructor.

Definition at line 16 of file Vocabulary.cpp.

Member Function Documentation

void aitools::invertedindex::Vocabulary::accumulate	(	const std::string &	word,
		uint64_t	frequency = `1`
	)

Accumulates the frequency of the given word with the given frequency or inserts the word with its frequency if it does not exist yet.

Definition at line 20 of file Vocabulary.cpp.

Referenced by BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

Vocabulary::iterator aitools::invertedindex::Vocabulary::begin ( )

Returns an iterator pointing to the first word in the vocabulary, or the end iterator, if the vocabulary is empty.

Definition at line 37 of file Vocabulary.cpp.

References hash_map_.

Vocabulary::const_iterator aitools::invertedindex::Vocabulary::begin ( ) const

Returns an const iterator pointing to the first word in the vocabulary, or the end iterator, if the vocabulary is empty.

Definition at line 31 of file Vocabulary.cpp.

void aitools::invertedindex::Vocabulary::clear ( )

Delete all words of the vocabulary.

Definition at line 43 of file Vocabulary.cpp.

References hash_map_.

Referenced by BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

bool aitools::invertedindex::Vocabulary::contains ( const std::string & word ) const

Checks if the vocabulary contains a given word.

Parameters:

word

the word to looking for.

Returns:: true if the word is part of the vocabulary.

Definition at line 49 of file Vocabulary.cpp.

References hash_map_.

Referenced by BOOST_AUTO_TEST_CASE(), and aitools::invertedindex::StorageSearcher::quantile().

Here is the caller graph for this function:

Vocabulary::iterator aitools::invertedindex::Vocabulary::end ( )

Returns an iterator pointing to the end of the vocabulary. Since this iterator points to a position one behind the last element, it must not be dereferenced.

Definition at line 61 of file Vocabulary.cpp.

References hash_map_.

Vocabulary::const_iterator aitools::invertedindex::Vocabulary::end ( ) const

Returns an const iterator pointing to the end of the vocabulary. Since this iterator points to a position one behind the last element, it must not be dereferenced.

Definition at line 55 of file Vocabulary.cpp.

References hash_map_.

Referenced by BOOST_AUTO_TEST_CASE(), and Java_de_aitools_aq_invertedindex_core_IndexSearcher_natGetFrequency().

Here is the caller graph for this function:

Vocabulary::iterator aitools::invertedindex::Vocabulary::find ( const std::string & word )

Returns an iterator pointing to the entry of the given word.

Returns:: a valid iterator or the end iterator.

Definition at line 73 of file Vocabulary.cpp.

References hash_map_.

Vocabulary::const_iterator aitools::invertedindex::Vocabulary::find ( const std::string & word ) const

Returns an iterator pointing to the entry of the given word.

Returns:: a valid iterator or the end iterator.

Definition at line 67 of file Vocabulary.cpp.

References hash_map_.

Referenced by BOOST_AUTO_TEST_CASE(), and Java_de_aitools_aq_invertedindex_core_IndexSearcher_natGetFrequency().

Here is the caller graph for this function:

uint64_t aitools::invertedindex::Vocabulary::frequency ( const std::string & word ) const

Returns the frequency to the given word.

Parameters:

word

Returns:: the frequency of the word or 0 if unknown.

Definition at line 79 of file Vocabulary.cpp.

References hash_map_.

void aitools::invertedindex::Vocabulary::get_words ( std::vector< std::string > & words ) const

Copies all words into the given vector. The set of words is always sorted.

Definition at line 86 of file Vocabulary.cpp.

Referenced by BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

bool aitools::invertedindex::Vocabulary::insert	(	const std::string &	word,
		uint64_t	frequency = `0`
	)

Inserts a word to the vocabulary.

Parameters:

word

the word to insert into the vocabulary.

Returns:: true if the key does not yet exist, false otherwise.

Definition at line 98 of file Vocabulary.cpp.

Referenced by BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

bool aitools::invertedindex::Vocabulary::is_empty ( ) const

Checks if the vocabulary is empty.

Returns:: true if the vocabulary is empty.

Definition at line 104 of file Vocabulary.cpp.

References hash_map_.

Referenced by BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

void aitools::invertedindex::Vocabulary::load ( const bfs::path & file ) throw (std::invalid_argument) [virtual]

Loads an vocabulary from an external file.

Parameters:

file

path and name of the input file.

Implements aitools::invertedindex::Externalizable.

Definition at line 110 of file Vocabulary.cpp.

References hash_map_.

Referenced by BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

void aitools::invertedindex::Vocabulary::save ( const bfs::path & file ) throw (std::invalid_argument) [virtual]

Saves an vocabulary to an external file. The vocabulary file is always sorted.

Parameters:

file

path and name of the output file.

Implements aitools::invertedindex::Externalizable.

Definition at line 135 of file Vocabulary.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), and aitools::invertedindex::StorageBuilder::close().

Here is the caller graph for this function:

size_t aitools::invertedindex::Vocabulary::size ( ) const

Gets the size of the vocabulary.

Returns:: the number of words.

Definition at line 152 of file Vocabulary.cpp.

Referenced by BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

Member Data Documentation

const char aitools::invertedindex::Vocabulary::delim = '\t' [static]

Definition at line 60 of file Vocabulary.hpp.

hash_map_t aitools::invertedindex::Vocabulary::hash_map_ [private]

Definition at line 193 of file Vocabulary.hpp.

Referenced by begin(), clear(), contains(), end(), find(), frequency(), is_empty(), and load().

const char aitools::invertedindex::Vocabulary::newline = '\n' [static]

Definition at line 61 of file Vocabulary.hpp.

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

/home/palakars/workspace-inprogress/code-in-progress/aitools3/aitools3-aq-invertedindex-cpp/src/util/Vocabulary.hpp
/home/palakars/workspace-inprogress/code-in-progress/aitools3/aitools3-aq-invertedindex-cpp/src/util/Vocabulary.cpp

aitools::invertedindex::Vocabulary Class Reference

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation