NAME

Lucy::Index::PostingList - Term-Document pairings.

SYNOPSIS

    my $posting_list_reader 
        = $seg_reader->obtain("Lucy::Index::PostingListReader");
    my $posting_list = $posting_list_reader->posting_list( 
        field => 'content',
        term  => 'foo',
    );
    while ( my $doc_id = $posting_list->next ) {
        say "Matching doc id: $doc_id";
    }

DESCRIPTION

PostingList is an iterator which supplies a list of document ids that match a given term.

See IRTheory for definitions of “posting” and “posting list”.

ABSTRACT METHODS

get_doc_freq

    my $int = $posting_list->get_doc_freq();

Return the number of documents that the PostingList contains. (This number will include any documents which have been marked as deleted but not yet purged.)

seek

    $posting_list->seek($target);
    $posting_list->seek();  # default: undef

Prepare the PostingList object to iterate over matches for documents that match target.

• target - The term to match. If undef, the iterator will be empty.

INHERITANCE

Lucy::Index::PostingList isa Lucy::Search::Matcher isa Clownfish::Obj.