Class representing an abstract class for a clusterer to be implemented. More...

#include <cluster.h>

Inheritance diagram for Xapian::Clusterer:

Collaboration diagram for Xapian::Clusterer:

Public Member Functions
virtual	~Clusterer ()
	Destructor. More...

virtual ClusterSet	cluster (const MSet &mset)=0
	Implement the required clustering algorithm in the subclass and and return clustered output as ClusterSet. More...

virtual std::string	get_description () const =0
	Returns a string describing the clusterer being used. More...

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

const Clusterer *	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::Internal::opt_intrusive_base
void	release () const
	Start reference counting. More...

Detailed Description

Class representing an abstract class for a clusterer to be implemented.

Definition at line 551 of file cluster.h.

Constructor & Destructor Documentation

◆ ~Clusterer()

virtual Xapian::Clusterer::~Clusterer ( )

virtual

Destructor.

Member Function Documentation

◆ cluster()

virtual ClusterSet Xapian::Clusterer::cluster ( const MSet & mset )

pure virtual

Implement the required clustering algorithm in the subclass and and return clustered output as ClusterSet.

Parameters

mset	The MSet object which contains the documents to be clustered

Implemented in Xapian::LCDClusterer, and Xapian::KMeans.

◆ get_description()

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

pure virtual

Returns a string describing the clusterer being used.

Implemented in Xapian::LCDClusterer, and Xapian::KMeans.

◆ release() [1/2]

Clusterer* Xapian::Clusterer::release ( )

inline

Start reference counting this object.

You can transfer ownership of a dynamically allocated Clusterer 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.

Definition at line 575 of file cluster.h.

◆ release() [2/2]

const Clusterer* Xapian::Clusterer::release ( ) const