meta::index::forward_index Class Reference

The forward_index stores information on a corpus by doc_ids. More...

#include <forward_index.h>

Inheritance diagram for meta::index::forward_index:

Classes
class	forward_index_exception
	Basic exception for forward_index interactions. More...
class	impl
	Implementation of a forward_index. More...

Public Types
using	primary_key_type = doc_id
using	secondary_key_type = term_id
using	postings_data_type = postings_data< doc_id, term_id >
using	inverted_pdata_type = postings_data< term_id, doc_id >
using	index_pdata_type = postings_data_type
using	exception = forward_index_exception

Public Member Functions
	forward_index (forward_index &&)
	Move constructs a forward_index.
forward_index &	operator= (forward_index &&)
	Move assigns a forward_index. More...
	forward_index (const forward_index &)=delete
	forward_index may not be copy-constructed.
forward_index &	operator= (const forward_index &)=delete
	forward_index may not be copy-assigned.
virtual	~forward_index ()
	Default destructor.
virtual std::shared_ptr< postings_data_type >	search_primary (doc_id d_id) const
std::string	liblinear_data (doc_id d_id) const
virtual uint64_t	unique_terms () const override
Public Member Functions inherited from meta::index::disk_index
virtual	~disk_index ()=default
	Default destructor.
std::string	index_name () const
uint64_t	num_docs () const
std::string	doc_name (doc_id d_id) const
std::string	doc_path (doc_id d_id) const
std::vector< doc_id >	docs () const
uint64_t	doc_size (doc_id d_id) const
class_label	label (doc_id d_id) const
label_id	lbl_id (doc_id d_id) const
label_id	id (class_label label) const
class_label	class_label_from_id (label_id l_id) const
uint64_t	num_labels () const
std::vector< class_label >	class_labels () const
virtual uint64_t	unique_terms (doc_id d_id) const
term_id	get_term_id (const std::string &term)
std::string	term_text (term_id t_id) const
	disk_index (disk_index &&)=default
	Move constructs a disk_index.
disk_index &	operator= (disk_index &&)=default
	Move assigns a disk_index.

Protected Member Functions
	forward_index (const cpptoml::table &config)
Protected Member Functions inherited from meta::index::disk_index
	disk_index (const cpptoml::table &config, const std::string &name)
	Constructor. More...
	disk_index (const disk_index &)=delete
	disk_index may not be copy-constructed.
disk_index &	operator= (const disk_index &)=delete
	disk_index may not be copy-assigned.

Private Member Functions
void	load_index ()
	This function loads a disk index from its filesystem representation.
void	create_index (const std::string &config_file)
	This function initializes the forward index. More...
bool	valid () const

Private Attributes
util::pimpl< impl >	fwd_impl_
	Implementation of this index.

Friends
template<class Index , class... Args>
std::shared_ptr< Index >	make_index (const std::string &config_file, Args &&...args)
	forward_index is a friend of the factory method used to create it. More...
template<class Index , template< class, class > class Cache, class... Args>
std::shared_ptr< cached_index< Index, Cache > >	make_index (const std::string &config_file, Args &&...args)
	forward_index is a friend of the factory method used to create cached versions of it. More...

Additional Inherited Members
Protected Attributes inherited from meta::index::disk_index
util::pimpl< disk_index_impl >	impl_
	Implementation of this disk_index.

Detailed Description

The forward_index stores information on a corpus by doc_ids.

Each doc_id key is associated with a distribution of term_ids or term "counts" that occur in that particular document.

Constructor & Destructor Documentation

meta::index::forward_index::forward_index ( const cpptoml::table &  config )

protected

Parameters

config

The table that specifies how to create the index.

Member Function Documentation

forward_index & meta::index::forward_index::operator= ( forward_index &&  )

default

Move assigns a forward_index.

Parameters

other

The forward_index to move into this one.

auto meta::index::forward_index::search_primary ( doc_id  d_id ) const

virtual

Parameters

d_id	The doc_id to search for

Returns

the postings data for a given doc_id

std::string meta::index::forward_index::liblinear_data

(

doc_id

d_id

)

const

Parameters

d_id	The document id of the doc to convert to liblinear format

Returns

the string representation liblinear format

uint64_t meta::index::forward_index::unique_terms ( ) const

overridevirtual

Returns

the number of unique terms in the index

Reimplemented from meta::index::disk_index.

void meta::index::forward_index::create_index ( const std::string &  config_file )

private

This function initializes the forward index.

Parameters

config_file

The configuration file used to create the index

bool meta::index::forward_index::valid ( ) const

private

Returns

whether this index contains all necessary files

Friends And Related Function Documentation

template<class Index , class... Args>

std::shared_ptr<Index> make_index ( const std::string &  config_file, Args &&...  args  )

friend

forward_index is a friend of the factory method used to create it.

Usage:

auto idx = index::make_index<derived_index_type>(config_path);

Parameters

config_file	The path to the configuration file to be used to build the index
args	any additional arguments to forward to the constructor for the chosen index type (usually none)

Returns

A properly initialized index

Usage:

auto idx =
    index::make_index<dervied_index_type,
                      cache_type>(config_path, other, options);

Other options will be forwarded to the constructor for the chosen cache class.

Parameters

config_file	the path to the configuration file to be used to build the index.
args	any additional arguments to forward to the constructor for the cache class chosen

Returns

A properly initialized, and automatically cached, index.

template<class Index , template< class, class > class Cache, class... Args>

std::shared_ptr<cached_index<Index, Cache> > make_index ( const std::string &  config_file, Args &&...  args  )

friend

forward_index is a friend of the factory method used to create cached versions of it.

forward_index is a friend of the factory method used to create it.

Usage:

auto idx = index::make_index<derived_index_type>(config_path);

Parameters

config_file	The path to the configuration file to be used to build the index
args	any additional arguments to forward to the constructor for the chosen index type (usually none)

Returns

A properly initialized index

forward_index is a friend of the factory method used to create it.

Usage:

auto idx =
    index::make_index<dervied_index_type,
                      cache_type>(config_path, other, options);

Other options will be forwarded to the constructor for the chosen cache class.

Parameters

config_file	the path to the configuration file to be used to build the index.
args	any additional arguments to forward to the constructor for the cache class chosen

Returns

A properly initialized, and automatically cached, index.

---

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

• /home/chase/projects/meta/include/index/forward_index.h
• /home/chase/projects/meta/src/index/forward_index.cpp