Pike Module Reference:

Convert a floating point number to a string, preserving sort order.

Convert a string encoded using sortable_serialise back to a floating point number.

Report the version string of the library which the program is linked with.

returns false if the weight object doesn't need doclength

Gets the maximum value that get_sumpart() may return.

This is used in optimising searches, by having the postlist tree decay appropriately when parts of it can have limited, or no, further effect.

Gets the maximum value that get_sumextra() may return.

This is used in optimising searches.

Get an extra weight for a document to add to the sum calculated over the query terms.

This returns a weight for a given document, and is used by some weighting schemes to account for influence such as document length.

the (unnormalised) document length.

the number of unique terms in the document.

Get a weight which is part of the sum over terms being performed.

This returns a weight for a given term and document. These weights are summed to give a total weight for the document.

the within document frequency of the term.

the (unnormalised) document length.

number of unique terms in the document (used for absolute smoothing)

Serialise object parameters into a string.

Name of the weighting scheme.

If the subclass is called FooWeight, this should return "Foo".

BM25 weighting scheme.

Boolean weighting scheme (everything gets 0).

Traditional probabilistic weighting scheme.

This class implements the Traditional Probabilistic Weighting scheme, as described by the early papers on Probabilistic Retrieval. BM25Weight generally gives better results.

Base class for value range processors.

Is term a stop-word?

1 if true, 0 otherwise.

Handle a string range.

The end points can be any strings.

Handle a number range.

This class must be used on values which have been encoded using Public.Xapian.sortable_serialise() which turns numbers into strings which will sort in the same order as the numbers (the same values can be used to implement a numeric sort).

The string supplied in str_ is used by operator() to decide whether the pair of strings supplied to it constitute a valid range. If prefix_ is true, the first value in a range must begin with str_ (and the second value may optionally begin with str_); if prefix_ is false, the second value in a range must end with str_ (and the first value may optionally end with str_).

If str_ is empty, the setting of prefix_ is irrelevant, and no special strings are required at the start or end of the strings defining the range.

The remainder of both strings defining the endpoints must be valid floating point numbers. (FIXME: define format recognised).

For example, if str_ is "$" and prefix_ is true, and the range processor has been added to the queryparser, the queryparser will accept "$10..50" or "$10..50", but not "10..50" or "10..$50" as valid ranges. If str_ is "kg" and prefix_ is false, the queryparser will accept "10..50kg" or "10kg..50kg", but not "10..50" or "10kg..50" as valid ranges.

The value number to return from `()().

Should ambiguous dates be interpreted as month/day/year rather than day/month/year?

Year to use as the epoch for dates with 2 digit years (default: 1970, so 1/1/69 is 2069 while 1/1/70 is 1970).

Base class for stop-word decision functor.

Is term a stop-word?

1 if true, 0 otherwise.

Simple implementation of Stopper class - this will suit most users.

Add a single stop word.

Class representing a stemming algorithm.

Construct a Stem object for a particular language.

Either the English name for the language or the two letter ISO639 code.

The following language names are understood (aliases follow the name):

* none - don't stem terms * danish (da) * dutch (nl) * english (en) - Martin Porter's 2002 revision of his stemmer * english_lovins (lovins) - Lovin's stemmer * english_porter (porter) - Porter's stemmer as described in his 1980 paper * finnish (fi) * french (fr) * german (de) * italian (it) * norwegian (no) * portuguese (pt) * russian (ru) * spanish (es) * swedish (sv)

an error will be thrown if the specified language is unknown.

stem a word

word to be stemmed

the word stem

this function is wide-string aware.

Class representing a query.

Queries are represented as a tree of objects.

Default constructor: makes an empty query which matches no documents.

Also useful for defining a Query object to be assigned to later.

An exception will be thrown if an attempt is made to use an undefined query when building up a composite query.

A query consisting of a single term.

A query consisting of two terms, opp-ed together.

A query consisting of two subqueries, opp-ed together.

Apply the specified operator to a single Query object, with a double parameter.

Get the length of the query, used by some ranking formulae.

This value is calculated automatically - if you want to override it you can pass a different value to Enquire.set_query().

Test if the query is empty (i.e. was constructed using the default constructor).

an object which can be passed to foreach()

A document in the database - holds data, values, terms, and postings.

Set data stored in the document.

Get an iterator for the values in this document.

a ValueIterator object which can be passed to foreach()

Get an iterator for the terms in this document.

a TermIterator object which can be passed to foreach()

Remove all terms (and postings) from the document.

Remove all values associated with the document.

Get data stored in the document. This is a potentially expensive operation, and shouldn't normally be used in a match decider function. Put data for use by match deciders in a value instead.

Get value by number.

The number of the value.

Returns an empty string if no value with the given number is present in the document.

Remove any value with the given number.

Add a term to the document, without positional information.

Any existing positional information for the term will be left unmodified.

The name of the term.

The increment that will be applied to the wdf for this term.

Add an occurrence of a term at a particular position.

Multiple occurrences of the term at the same position are represented only once in the positional information, but do increase the wdf.

If the term is not already in the document, it will be added to it.

The name of the term.

The position of the term.

The increment that will be applied to the wdf for this term.

Remove a term and all postings associated with it.

The name of the term.

An error will be thrown if the term is not present in the document.

Remove a posting of a term from the document.

Note that the term will still index the document even if all occurrences are removed. To remove a term from a document completely, use remove_term().

The name of the term.

The position of the term.

The decrement that will be applied to the wdf when removing this posting. The wdf will not go below the value of 0.

An error will be thrown if the term is not at the position specified in the position list for this term in this document or if the term is not in the document.

Add a new value.

It will replace any existing value with the same number.

Count the terms in this document.

the number of terms in the document.

Count the values in this document.

the number of values in the document.

Get an iterator for the synonyms of a term.

a TermIterator object which can be passed to foreach()

a TermIterator object which can also be passed to foreach()

a TermIterator object which can also be passed to foreach()

Suggest a spelling correction.

The potentially misspelled word.

Only consider words which are at most max_edit_distance edits from word. An edit is a character insertion, deletion, or the transposition of two adjacent characters (a reasonable starting value is 2).

Set the stemming strategy.

This controls how the query parser will apply the stemming algorithm. The default value is STEM_NONE. The possible values are:

* STEM_NONE: Don't perform any stemming.

* STEM_SOME: Search for stemmed forms of terms except for those which start with a capital letter, or are followed by certain characters (currently: (/@<>=*[{" ), or are used with operators which need positional information. Stemmed terms are prefixed with 'Z'.

* STEM_ALL: Search for stemmed forms of all words (note: no 'Z' prefix is added).

Note that the stemming algorithm is only applied to words in probabilistic fields - boolean filter terms are never stemmed.

a plain text query string

a Query object

this function is wide-string aware

a TermIterator object which can also be passed to foreach()

this function is wide-string aware.

this function is wide-string aware.