/usr/lib/x86_64-linux-gnu/perl5/5.24/Lucy/Search/Collector/BitCollector.pod is in liblucy-perl 0.3.3-7+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 | # Auto-generated file -- DO NOT EDIT!!!!!
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
=head1 NAME
Lucy::Search::Collector::BitCollector - Collector which records doc nums in a BitVector.
=head1 SYNOPSIS
my $bit_vec = Lucy::Object::BitVector->new(
capacity => $searcher->doc_max + 1,
);
my $bit_collector = Lucy::Search::Collector::BitCollector->new(
bit_vector => $bit_vec,
);
$searcher->collect(
collector => $bit_collector,
query => $query,
);
=head1 DESCRIPTION
BitCollector is a Collector which saves matching document ids in a
L<BitVector|Lucy::Object::BitVector>. It is useful for recording the
entire set of documents which matches a query.
=head1 CONSTRUCTORS
=head2 new( I<[labeled params]> )
my $bit_collector = Lucy::Search::Collector::BitCollector->new(
bit_vector => $bit_vec, # required
);
=over
=item *
B<bit_vector> - A Lucy::Object::BitVector.
=back
=head1 METHODS
=head2 collect(doc_id)
Set bit in the object's BitVector for the supplied doc id.
=head1 INHERITANCE
Lucy::Search::Collector::BitCollector isa L<Lucy::Search::Collector> isa L<Lucy::Object::Obj>.
=cut
|