xapian-core  1.5.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Xapian::PointType Class Reference

Abstract class representing a point in the VSM. More...

+ Inheritance diagram for Xapian::PointType:

Public Member Functions

 PointType ()
 Default constructor.
 
TermIterator termlist_begin () const
 Return a TermIterator to the beginning of the termlist.
 
TermIterator termlist_end () const noexcept
 Return a TermIterator to the end of the termlist.
 
bool contains (const std::string &term) const
 Validate whether a certain term exists in the termlist or not by performing a lookup operation in the existing values. More...
 
double get_weight (const std::string &term) const
 Return the TF-IDF weight associated with a certain term. More...
 
void add_weight (const std::string &term, double weight)
 Add the weight 'weight' to the mapping of a term. More...
 
double get_magnitude () const
 Return the pre-computed squared magnitude.
 
Xapian::termcount termlist_size () const
 Return the size of the termlist.
 
PointTyperelease ()
 Start reference counting this object. More...
 
const PointTyperelease () const
 Start reference counting this object. More...
 

Protected Member Functions

void set_weight (const std::string &term, double weight)
 Set the weight 'weight' to the mapping of a term. More...
 

Protected Attributes

std::unordered_map< std::string, double > weights
 Implement a map to store the terms within a document and their pre-computed TF-IDF weights.
 
double magnitude
 Store the squared magnitude of the PointType.
 

Detailed Description

Abstract class representing a point in the VSM.

Member Function Documentation

◆ add_weight()

void Xapian::PointType::add_weight ( const std::string &  term,
double  weight 
)

Add the weight 'weight' to the mapping of a term.

Parameters
termTerm to which the weight is to be added
weightWeight which has to be added to the existing mapping of the term

◆ contains()

bool Xapian::PointType::contains ( const std::string &  term) const

Validate whether a certain term exists in the termlist or not by performing a lookup operation in the existing values.

Parameters
termTerm which is to be searched

◆ get_weight()

double Xapian::PointType::get_weight ( const std::string &  term) const

Return the TF-IDF weight associated with a certain term.

Parameters
termTerm for which TF-IDF weight is returned

◆ release() [1/2]

PointType* Xapian::PointType::release ( )
inline

Start reference counting this object.

You can hand ownership of a dynamically allocated PointType object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

◆ release() [2/2]

const PointType* Xapian::PointType::release ( ) const
inline

Start reference counting this object.

You can hand ownership of a dynamically allocated PointType object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

◆ set_weight()

void Xapian::PointType::set_weight ( const std::string &  term,
double  weight 
)
protected

Set the weight 'weight' to the mapping of a term.

Parameters
termTerm for which the weight is supposed to be changed
weightThe weight to which the mapping of the term is to be set

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