xapian_mset_get_firstitem ()

unsigned int
xapian_mset_get_firstitem (XapianMSet *mset);

Retrieves the index of the first item in the mset .

xapian_mset_get_termfreq ()

unsigned int
xapian_mset_get_termfreq (XapianMSet *mset,
                          const char *term);

Retrieves the frequency of the given term .

xapian_mset_get_termweight ()

double
xapian_mset_get_termweight (XapianMSet *mset,
                            const char *term);

Retrieves the weight of the given term .

xapian_mset_get_matches_lower_bound ()

unsigned int
xapian_mset_get_matches_lower_bound (XapianMSet *mset);

Retrieves the lower bound of the matching documents in the database.

xapian_mset_get_matches_estimated ()

unsigned int
xapian_mset_get_matches_estimated (XapianMSet *mset);

Retrieves an estimation of the matching documents in the database.

xapian_mset_get_matches_upper_bound ()

unsigned int
xapian_mset_get_matches_upper_bound (XapianMSet *mset);

Retrieves the upper bound of the matching documents in the database.

xapian_mset_get_uncollapsed_matches_lower_bound ()

unsigned int
xapian_mset_get_uncollapsed_matches_lower_bound
                               (XapianMSet *mset);

Retrieves the lower bound of the matching documents in the database if collapsing was not used.

xapian_mset_get_uncollapsed_matches_estimated ()

unsigned int
xapian_mset_get_uncollapsed_matches_estimated
                               (XapianMSet *mset);

Retrieves an estimated number of matching documents in the database if collapsing was not used.

xapian_mset_get_uncollapsed_matches_upper_bound ()

unsigned int
xapian_mset_get_uncollapsed_matches_upper_bound
                               (XapianMSet *mset);

Retrieves the upper bound of the matching documents in the database if collapsing was not used.

xapian_mset_get_max_possible ()

double
xapian_mset_get_max_possible (XapianMSet *mset);

The maximum possible weight in the mset .

See also: xapian_mset_get_max_attained()

xapian_mset_get_max_attained ()

double
xapian_mset_get_max_attained (XapianMSet *mset);

The greatest weight which is attained by any document in the database.

If mset was the result of xapian_enquire_get_mset() with a first item set to 0, the returned value is the weight of the first item in the mset .

xapian_mset_get_size ()

unsigned int
xapian_mset_get_size (XapianMSet *mset);

Retrieves the number of items in the mset .

xapian_mset_is_empty ()

gboolean
xapian_mset_is_empty (XapianMSet *mset);

Checks whether the mset is empty.

xapian_mset_convert_to_percent ()

int
xapian_mset_convert_to_percent (XapianMSet *mset,
                                double weight);

Converts a weight, typically returned by xapian_mset_iterator_get_weight(), into a percentage.

xapian_mset_get_begin ()

XapianMSetIterator *
xapian_mset_get_begin (XapianMSet *mset);

Creates an iterator placed before the beginning of the mset .

In order to access the contents of the mset through the XapianMSetIterator API you will have to advance the iterator first, e.g.:

1
2
3
4
5
6
7
8

XapianMSetIter *iter = xapian_mset_get_begin (mset);

while (xapian_mset_iterator_next (iter))
  {
    // ...
  }

g_object_unref (iter);

xapian_mset_get_end ()

XapianMSetIterator *
xapian_mset_get_end (XapianMSet *mset);

Creates a new XapianMSetIterator placed after the end of the mset .

In order to access the contents of the mset through the XapianMSetIterator API you will have to advance the iterator first, e.g.:

1
2
3
4
5
6
7
8

XapianMSetIter *iter = xapian_mset_get_end (mset);

while (xapian_mset_iterator_prev (iter))
  {
    // ...
  }

g_object_unref (iter);