Project Lucy has retired. For details please refer to its Attic page.
Lucy::Search::Collector::BitCollector – C API Documentation
Apache Lucy™

Lucy::Search::Collector::BitCollector

parcel Lucy
class variable LUCY_BITCOLLECTOR
struct symbol lucy_BitCollector
class nickname lucy_BitColl
header file Lucy/Search/Collector.h

Name

Lucy::Search::Collector::BitCollector – Collector which records doc nums in a BitVector.

Description

BitCollector is a Collector which saves matching document ids in a BitVector. It is useful for recording the entire set of documents which matches a query.

Functions

new
lucy_BitCollector* // incremented
lucy_BitColl_new(
    lucy_BitVector *bit_vector
);

Create a new BitCollector.

bit_vector

A Lucy::Object::BitVector.

init
lucy_BitCollector*
lucy_BitColl_init(
    lucy_BitCollector *self,
    lucy_BitVector *bit_vector
);

Initialize a BitCollector.

bit_vector

A Lucy::Object::BitVector.

Methods

Collect
void
lucy_BitColl_Collect(
    lucy_BitCollector *self,
    int32_t doc_id
);

Set bit in the object’s BitVector for the supplied doc id.

Inheritance

Lucy::Search::Collector::BitCollector is a Lucy::Search::Collector is a Clownfish::Obj.