xapian-core  1.5.0
Public Member Functions | List of all members
Xapian::Similarity Class Referenceabstract

Base class for calculating the similarity between documents. More...

+ Inheritance diagram for Xapian::Similarity:

Public Member Functions

virtual ~Similarity ()
 Destructor.
 
virtual double similarity (const PointType &a, const PointType &b) const =0
 Calculates the similarity between the two documents. More...
 
virtual std::string get_description () const =0
 Returns a string describing the similarity metric being used.
 

Detailed Description

Base class for calculating the similarity between documents.

Member Function Documentation

◆ similarity()

virtual double Xapian::Similarity::similarity ( const PointType a,
const PointType b 
) const
pure virtual

Calculates the similarity between the two documents.

Parameters
aFirst point object for distance calculation
bSecond point object for distance calculation

Implemented in Xapian::CosineDistance.


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