Xapian::ValueWeightPostingSource Class Reference

A posting source which reads weights from a value slot. More...

`#include <postingsource.h>`

Inheritance diagram for Xapian::ValueWeightPostingSource:
[legend]

## Public Member Functions

| ValueWeightPostingSource (Xapian::valueno slot_)
| Construct a ValueWeightPostingSource. More...
double | get_weight () const
| Return the weight contribution for the current document. More...
ValueWeightPostingSource * | clone () const
| Clone the posting source. More...
std::string | name () const
| Name of the posting source class. More...
std::string | serialise () const
| Serialise object parameters into a string. More...
ValueWeightPostingSource * | unserialise (const std::string &serialised) const
| Create object given string serialisation returned by serialise(). More...
void | init (const Database &db_)
| Set this PostingSource to the start of the list of postings. More...
std::string | get_description () const
| Return a string describing this object. More...
Public Member Functions inherited from Xapian::ValuePostingSource
| ValuePostingSource (Xapian::valueno slot_)
| Construct a ValuePostingSource. More...
Xapian::doccount | get_termfreq_min () const
| A lower bound on the number of documents this object can return. More...
Xapian::doccount | get_termfreq_est () const
| An estimate of the number of documents this object can return. More...
Xapian::doccount | get_termfreq_max () const
| An upper bound on the number of documents this object can return. More...
void | next (double min_wt)
| Advance the current position to the next matching document. More...
void | skip_to (Xapian::docid min_docid, double min_wt)
| Advance to the specified docid. More...
bool | check (Xapian::docid min_docid, double min_wt)
| Check if the specified docid occurs. More...
bool | at_end () const
| Return true if the current position is past the last entry in this list. More...
Xapian::docid | get_docid () const
| Return the current docid. More...
void | init (const Database &db_)
| Set this PostingSource to the start of the list of postings. More...
Xapian::Database | get_database () const
| The database we're reading values from. More...
Xapian::valueno | get_slot () const
| The slot we're reading values from. More...
std::string | get_value () const
| Read current value. More...
void | done ()
| End the iteration. More...
bool | get_started () const
| Flag indicating if we've started (true if we have). More...
void | set_termfreq_min (Xapian::doccount termfreq_min_)
| Set a lower bound on the term frequency. More...
void | set_termfreq_est (Xapian::doccount termfreq_est_)
| An estimate of the term frequency. More...
void | set_termfreq_max (Xapian::doccount termfreq_max_)
| An upper bound on the term frequency. More...
Public Member Functions inherited from Xapian::PostingSource
| PostingSource ()
| Allow subclasses to be instantiated.
virtual Xapian::doccount | get_termfreq_min () const =0
| A lower bound on the number of documents this object can return. More...
virtual Xapian::doccount | get_termfreq_est () const =0
| An estimate of the number of documents this object can return. More...
virtual Xapian::doccount | get_termfreq_max () const =0
| An upper bound on the number of documents this object can return. More...
void | set_maxweight (double max_weight)
| Specify an upper bound on what get_weight() will return from now on. More...
double | get_maxweight () const
| Return the currently set upper bound on what get_weight() can return.
virtual double | get_weight () const
| Return the weight contribution for the current document. More...
virtual Xapian::docid | get_docid () const =0
| Return the current docid. More...
virtual void | next (double min_wt)=0
| Advance the current position to the next matching document. More...
virtual void | skip_to (Xapian::docid did, double min_wt)
| Advance to the specified docid. More...
virtual bool | check (Xapian::docid did, double min_wt)
| Check if the specified docid occurs. More...
virtual bool | at_end () const =0
| Return true if the current position is past the last entry in this list. More...
virtual PostingSource * | clone () const
| Clone the posting source. More...
virtual std::string | name () const
| Name of the posting source class. More...
virtual std::string | serialise () const
| Serialise object parameters into a string. More...
virtual PostingSource * | unserialise (const std::string &serialised) const
| Create object given string serialisation returned by serialise(). More...
virtual PostingSource * | unserialise_with_registry (const std::string &serialised, const Registry &registry) const
| Create object given string serialisation returned by serialise(). More...
virtual void | init (const Database &db)=0
| Set this PostingSource to the start of the list of postings. More...
virtual std::string | get_description () const
| Return a string describing this object. More...
PostingSource * | release ()
| Start reference counting this object. More...
const PostingSource * | release () const
| Start reference counting this object. More...

## Additional Inherited Members

Protected Attributes inherited from Xapian::ValuePostingSource
Xapian::Database & | db
| The database we're reading values from. More...
Xapian::valueno & | slot
| The slot we're reading values from. More...
Xapian::ValueIterator & | value_it
| Value stream iterator. More...
bool & | started
| Flag indicating if we've started (true if we have). More...
Xapian::doccount & | termfreq_min
| A lower bound on the term frequency. More...
Xapian::doccount & | termfreq_est
| An estimate of the term frequency. More...
Xapian::doccount & | termfreq_max
| An upper bound on the term frequency. More...

## Detailed Description

A posting source which reads weights from a value slot.

This returns entries for all documents in the given database which have a non empty values in the specified slot. It returns a weight calculated by applying sortable_unserialise to the value stored in the slot (so the values stored should probably have been calculated by applying sortable_serialise to a floating point number at index time).

The upper bound on the weight returned is set using the upper bound on the values in the specified slot, or DBL_MAX if value bounds aren't supported by the current backend.

For efficiency, this posting source doesn't check that the stored values are valid in any way, so it will never raise an exception due to invalid stored values. In particular, it doesn't ensure that the unserialised values are positive, which is a requirement for weights. The behaviour if the slot contains values which unserialise to negative values is undefined.

## Constructor & Destructor Documentation

## ValueWeightPostingSource()

Xapian::ValueWeightPostingSource::ValueWeightPostingSource | ( | Xapian::valueno | slot_ | ) |

explicit

Construct a ValueWeightPostingSource.

Parameters

  slot_ | The value slot to read values from.

## Member Function Documentation

## clone()

ValueWeightPostingSource * Xapian::ValueWeightPostingSource::clone | ( |  | ) | const

virtual

Clone the posting source.

The clone should inherit the configuration of the parent, but need not inherit the state. ie, the clone does not need to be in the same iteration position as the original: the matcher will always call init() on the clone before attempting to move the iterator, or read the information about the current position of the iterator.

This may return NULL to indicate that cloning is not supported. In this case, the PostingSource may only be used with a single-database search.

The default implementation returns NULL.

Note that the returned object will be deallocated by Xapian after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the Xapian API for use from another language) then you can define a static `operator delete` method in your subclass as shown here: https://trac.xapian.org/ticket/554#comment:1

Reimplemented from Xapian::PostingSource.

Reimplemented in Xapian::DecreasingValueWeightPostingSource.

## get_description()

std::string Xapian::ValueWeightPostingSource::get_description | ( |  | ) | const

virtual

Return a string describing this object.

This default implementation returns a generic answer. This default it provided to avoid forcing those deriving their own PostingSource subclass from having to implement this (they may not care what get_description() gives for their subclass).

Reimplemented from Xapian::PostingSource.

Reimplemented in Xapian::DecreasingValueWeightPostingSource.

## get_weight()

double Xapian::ValueWeightPostingSource::get_weight | ( |  | ) | const

virtual

Return the weight contribution for the current document.

This default implementation always returns 0, for convenience when implementing "weight-less" PostingSource subclasses.

This method may assume that it will only be called when there is a "current document". In detail: Xapian will always call init() on a PostingSource before calling this for the first time. It will also only call this if the PostingSource reports that it is pointing to a valid document (ie, it will not call it before calling at least one of next(), skip_to() or check(), and will ensure that the PostingSource is not at the end by calling at_end()).

Reimplemented from Xapian::PostingSource.

Reimplemented in Xapian::DecreasingValueWeightPostingSource.

## init()

void Xapian::ValueWeightPostingSource::init | ( | const Database & | db | ) |

virtual

Set this PostingSource to the start of the list of postings.

This is called automatically by the matcher prior to each query being processed.

If a PostingSource is used for multiple searches, init() will therefore be called multiple times, and must handle this by using the database passed in the most recent call.

Parameters

  db | The database which the PostingSource should iterate through.

Note: in the case of a multi-database search, a separate PostingSource will be used for each database (the separate PostingSources will be obtained using clone()), and each PostingSource will be passed one of the sub-databases as the db parameter here. The db parameter will therefore always refer to a single database. All docids passed to, or returned from, the PostingSource refer to docids in that single database, rather than in the multi-database.

Reimplemented from Xapian::ValuePostingSource.

Reimplemented in Xapian::DecreasingValueWeightPostingSource.

## name()

std::string Xapian::ValueWeightPostingSource::name | ( |  | ) | const

virtual

Name of the posting source class.

This is used when serialising and unserialising posting sources; for example, for performing remote searches.

If the subclass is in a C++ namespace, the namespace should be included in the name, using "::" as a separator. For example, for a PostingSource subclass called "FooPostingSource" in the "Xapian" namespace the result of this call should be "Xapian::FooPostingSource".

This should only be implemented if serialise() and unserialise() are also implemented. The default implementation returns an empty string.

If this returns an empty string, Xapian will assume that serialise() and unserialise() are not implemented.

Reimplemented from Xapian::PostingSource.

Reimplemented in Xapian::DecreasingValueWeightPostingSource.

## serialise()

std::string Xapian::ValueWeightPostingSource::serialise | ( |  | ) | const

virtual

Serialise object parameters into a string.

The serialised parameters should represent the configuration of the posting source, but need not (indeed, should not) represent the current iteration state.

If you don't want to support the remote backend, you can use the default implementation which simply throws Xapian::UnimplementedError.

Reimplemented from Xapian::PostingSource.

Reimplemented in Xapian::DecreasingValueWeightPostingSource.

## unserialise()

ValueWeightPostingSource * Xapian::ValueWeightPostingSource::unserialise | ( | const std::string & | serialised | ) | const

virtual

Create object given string serialisation returned by serialise().

Note that the returned object will be deallocated by Xapian after use with "delete". If you want to handle the deletion in a special way (for example when wrapping the Xapian API for use from another language) then you can define a static `operator delete` method in your subclass as shown here: https://trac.xapian.org/ticket/554#comment:1

If you don't want to support the remote backend, you can use the default implementation which simply throws Xapian::UnimplementedError.

Parameters

  serialised | A serialised instance of this PostingSource subclass.

Reimplemented from Xapian::PostingSource.

Reimplemented in Xapian::DecreasingValueWeightPostingSource.

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

- xapian/postingsource.h