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

Class for diversifying an MSet using GLS-MPT as given in the paper: Scalable and Efficient Web Search Result Diversification Naini et al. More...

Public Member Functions

 Diversify (const Diversify &other)
 Copying is allowed. More...
 
Diversifyoperator= (const Diversify &other)
 Assignment is allowed. More...
 
 Diversify (Diversify &&other)
 Move constructor. More...
 
Diversifyoperator= (Diversify &&other)
 Move assignment operator. More...
 
 Diversify (Xapian::doccount k_, Xapian::doccount r_, double lambda_=0.5, double b_=5.0, double sigma_sqr_=1e-3)
 Constructor specifying the number of diversified search results. More...
 
 ~Diversify ()
 Destructor.
 
Xapian::DocumentSet get_dmset (const MSet &mset)
 Implements diversification. More...
 
std::string get_description () const
 Return a string describing this object.
 

Detailed Description

Class for diversifying an MSet using GLS-MPT as given in the paper: Scalable and Efficient Web Search Result Diversification Naini et al.

2016

Constructor & Destructor Documentation

◆ Diversify() [1/3]

Xapian::Diversify::Diversify ( const Diversify other)

Copying is allowed.

The internals are reference counted, so copying is cheap.

Parameters
otherThe object to copy.

◆ Diversify() [2/3]

Xapian::Diversify::Diversify ( Diversify &&  other)

Move constructor.

Parameters
otherThe object to move.

◆ Diversify() [3/3]

Xapian::Diversify::Diversify ( Xapian::doccount  k_,
Xapian::doccount  r_,
double  lambda_ = 0.5,
double  b_ = 5.0,
double  sigma_sqr_ = 1e-3 
)
explicit

Constructor specifying the number of diversified search results.

Parameters
k_Number of required diversified documents in the diversified document set
r_Number of documents from each cluster used for building topC
lambda_Trade-off between relevance of top-k diversified document set and its similarity to the rest of the documents in the document match set. Belongs to the range [0,1] with 0 meaning no weighting to relevance of the diversified document set and 1 allowing for full weighting to relevance of the diversified document set.
b_Parameter for MPT, normally in the range [1,10]
sigma_sqr_Parameter for MPT, normally in the range [1e-6,1]

Member Function Documentation

◆ get_dmset()

Xapian::DocumentSet Xapian::Diversify::get_dmset ( const MSet mset)

Implements diversification.

Performs GLS-MPT and returns documents of which top-k are diversified.

Parameters
msetMSet object containing the documents of which top-k are to be diversified

◆ operator=() [1/2]

Diversify& Xapian::Diversify::operator= ( const Diversify other)

Assignment is allowed.

The internals are reference counted, so assignment is cheap.

Parameters
otherThe object to copy.

◆ operator=() [2/2]

Diversify& Xapian::Diversify::operator= ( Diversify &&  other)

Move assignment operator.

Parameters
otherThe object to move.

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