Class to represent cluster centroids in the vector space. More...

#include <cluster.h>

Inheritance diagram for Xapian::Centroid:

Collaboration diagram for Xapian::Centroid:

Public Member Functions
	Centroid ()
	Default constructor. More...

	Centroid (const Point &point)
	Constructor with Point argument. More...

void	divide (double cluster_size)
	Divide the weight of terms in the centroid by 'size' and recalculate the magnitude. More...

void	clear ()
	Clear the terms and corresponding values of the centroid. More...

Public Member Functions inherited from Xapian::PointType
	PointType ()
	Default constructor. More...

TermIterator	termlist_begin () const
	Return a TermIterator to the beginning of the termlist. More...

TermIterator	termlist_end () const noexcept
	Return a TermIterator to the end of the termlist. More...

bool	contains (std::string_view 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 (std::string_view term) const
	Return the TF-IDF weight associated with a certain term. More...

void	add_weight (std::string_view term, double weight)
	Add the weight 'weight' to the mapping of a term. More...

double	get_magnitude () const
	Return the pre-computed squared magnitude. More...

Xapian::termcount	termlist_size () const
	Return the size of the termlist. More...

PointType *	release ()
	Start reference counting this object. More...

const PointType *	release () const
	Start reference counting this object. More...

Public Member Functions inherited from Xapian::Internal::opt_intrusive_base
	opt_intrusive_base (const opt_intrusive_base &)

opt_intrusive_base &	operator= (const opt_intrusive_base &)

	opt_intrusive_base ()
	Construct object which is initially not reference counted. More...

virtual	~opt_intrusive_base ()

void	ref () const

void	unref () const

Additional Inherited Members
Public Attributes inherited from Xapian::Internal::opt_intrusive_base
unsigned	_refs
	Reference count. More...

Protected Member Functions inherited from Xapian::PointType
void	set_weight (std::string_view term, double weight)
	Set the weight 'weight' to the mapping of a term. More...

Protected Member Functions inherited from Xapian::Internal::opt_intrusive_base
void	release () const
	Start reference counting. More...

Protected Attributes inherited from Xapian::PointType
std::unordered_map< std::string, double >	weights
	Implement a map to store the terms within a document and their pre-computed TF-IDF weights. More...

double	magnitude = 0.0
	Store the squared magnitude of the PointType. More...

Detailed Description

Class to represent cluster centroids in the vector space.

Definition at line 342 of file cluster.h.

Constructor & Destructor Documentation

◆ Centroid() [1/2]

Xapian::Centroid::Centroid ( )

inline

Default constructor.

Definition at line 345 of file cluster.h.

◆ Centroid() [2/2]

Xapian::Centroid::Centroid ( const Point & point )

explicit

Constructor with Point argument.

Parameters

point Point object to which Centroid object is initialised. The document vector and the magnitude are made equal

Member Function Documentation

◆ clear()

void Xapian::Centroid::clear ( )

inline

Clear the terms and corresponding values of the centroid.

Definition at line 364 of file cluster.h.

◆ divide()

void Xapian::Centroid::divide ( double cluster_size )

Divide the weight of terms in the centroid by 'size' and recalculate the magnitude.

Parameters

cluster_size Value by which Centroid document vector is divided

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

include/xapian/cluster.h

Public Member Functions