Xapian::Similarity Class Reference

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

#include <cluster.h>

Inheritance diagram for Xapian::Similarity:

Public Member Functions
virtual	~Similarity ()
	Destructor. More...
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. More...

Detailed Description

Base class for calculating the similarity between documents.

Definition at line 520 of file cluster.h.

Constructor & Destructor Documentation

~Similarity()

virtual Xapian::Similarity::~Similarity ( )

virtual

Destructor.

Member Function Documentation

get_description()

virtual std::string Xapian::Similarity::get_description ( ) const

pure virtual

Returns a string describing the similarity metric being used.

Implemented in Xapian::CosineDistance.

similarity()

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

pure virtual

Calculates the similarity between the two documents.

Parameters

a	First point object for distance calculation
b	Second point object for distance calculation

Implemented in Xapian::CosineDistance.

---

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

• include/xapian/cluster.h