.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "KinoSearch::Search::HitCollector 3"
.TH KinoSearch::Search::HitCollector 3 "2008-01-14" "perl v5.8.8" "User Contributed Perl Documentation"
void
collect(hc, doc_num, score)
    HitCollector *hc;
    U32           doc_num;
    float         score;
\&\s-1PPCODE:\s0
    hc\->collect(hc, doc_num, score);
.PP
SV* 
_set_or_get(hc, ...)
    HitCollector *hc;
\&\s-1ALIAS:\s0
    _set_storage     = 1
    get_storage      = 2
    _set_i           = 3
    get_i            = 4
    _set_f           = 5
    _get_f           = 6
    _set_filter_bits = 7
    _get_filter_bits = 8
\&\s-1CODE:\s0
{
    \s-1KINO_START_SET_OR_GET_SWITCH\s0
.PP
.Vb 6
\&    case 1:  SvREFCNT_dec(hc->storage_ref);
\&             hc->storage_ref = newSVsv( ST(1) );
\&             Kino_extract_anon_struct(hc->storage_ref, hc->storage);
\&             /* fall through */
\&    case 2:  RETVAL = newSVsv(hc->storage_ref);
\&             break;
.Ve
.PP
.Vb 4
\&    case 3:  hc->i = SvUV( ST(1) );
\&             /* fall through */
\&    case 4:  RETVAL = newSVuv(hc->i);
\&             break;
.Ve
.PP
.Vb 4
\&    case 5:  hc->f = SvNV( ST(1) );
\&             /* fall through */
\&    case 6:  RETVAL = newSVnv(hc->f);
\&             break;
.Ve
.PP
.Vb 7
\&    case 7:  SvREFCNT_dec(hc->filter_bits_ref);
\&             hc->filter_bits_ref = newSVsv( ST(1) );
\&             Kino_extract_struct( hc->filter_bits_ref, hc->filter_bits, 
\&                BitVector*, "KinoSearch::Util::BitVector" );
\&             /* fall through */
\&    case 8:  RETVAL = newSVsv(hc->filter_bits_ref);
\&             break;
.Ve
.PP
.Vb 3
\&    KINO_END_SET_OR_GET_SWITCH
\&}
\&OUTPUT: RETVAL
.Ve
.PP
void
\&\s-1DESTROY\s0(hc)
    HitCollector *hc;
\&\s-1PPCODE:\s0
    Kino_HC_destroy(hc);
.PP
\&\s-1MODULE\s0 = KinoSearch    \s-1PACKAGE\s0 = KinoSearch::Search::HitQueueCollector
.PP
void
_define_collect(hc)
    HitCollector *hc;
\&\s-1PPCODE:\s0
    hc\->collect = Kino_HC_collect_HitQueue;
.PP
\&\s-1MODULE\s0 = KinoSearch    \s-1PACKAGE\s0 = KinoSearch::Search::BitCollector
.PP
void
_define_collect(hc)
    HitCollector *hc;
\&\s-1PPCODE:\s0
    hc\->collect = Kino_HC_collect_BitVec;
.PP
\&\s-1MODULE\s0 = KinoSearch    \s-1PACKAGE\s0 = KinoSearch::Search::FilteredCollector
.PP
void
_define_collect(hc);
    HitCollector *hc;
\&\s-1PPCODE:\s0
    hc\->collect = Kino_HC_collect_filtered;
.PP
\&\s-1MODULE\s0 = KinoSearch    \s-1PACKAGE\s0 = KinoSearch::Search::OffsetCollector
.PP
void
_define_collect(hc);
    HitCollector *hc;
\&\s-1PPCODE:\s0
    hc\->collect = Kino_HC_collect_offset;
.PP
_\|_H_\|_
.PP
#ifndef H_KINO_HIT_COLLECTOR
#define H_KINO_HIT_COLLECTOR 1
.PP
#include \*(L"\s-1EXTERN\s0.h\*(R"
#include \*(L"perl.h\*(R"
#include \*(L"\s-1XSUB\s0.h\*(R"
#include \*(L"KinoSearchUtilCarp.h\*(R"
#include \*(L"KinoSearchUtilMathUtils.h\*(R"
#include \*(L"KinoSearchUtilBitVector.h\*(R"
#include \*(L"KinoSearchUtilPriorityQueue.h\*(R"
#include \*(L"KinoSearchUtilMemManager.h\*(R"
.PP
typedef struct hitcollector {
    void      (*collect)(struct hitcollector*, U32, float);
    float       f;
    U32         i;
    void       *storage;
    \s-1SV\s0         *storage_ref;
    BitVector  *filter_bits;
    \s-1SV\s0         *filter_bits_ref;
} HitCollector;
.PP
HitCollector* \fIKino_HC_new()\fR;
void Kino_HC_collect_death(HitCollector*, U32, float);
void Kino_HC_collect_HitQueue(HitCollector*, U32, float);
void Kino_HC_collect_BitVec(HitCollector*, U32, float);
void Kino_HC_collect_filtered(HitCollector*, U32, float);
void Kino_HC_collect_offset(HitCollector*, U32, float);
void Kino_HC_destroy(HitCollector*);
.PP
#endif /* include guard */
.PP
_\|_C_\|_
.PP
#include \*(L"KinoSearchSearchHitCollector.h\*(R"
.PP
HitCollector*
\&\fIKino_HC_new()\fR {
    HitCollector  *hc;
.PP
.Vb 8
\&    /* allocate memory and init */
\&    Kino_New(0, hc, 1, HitCollector);
\&    hc->f               = 0;
\&    hc->i               = 0;
\&    hc->storage         = NULL;
\&    hc->storage_ref     = &PL_sv_undef;
\&    hc->filter_bits     = NULL;
\&    hc->filter_bits_ref = &PL_sv_undef;
.Ve
.PP
.Vb 2
\&    /* force the subclass to spec a collect method */
\&    hc->collect = Kino_HC_collect_death;
.Ve
.PP
.Vb 2
\&    return hc;
\&}
.Ve
.PP
void
Kino_HC_collect_death(HitCollector *hc, U32 doc_num, float score) {
    Kino_confess(\*(L"hit_collector\->collect must be assigned in a subclass\*(R");
}
.PP
void
Kino_HC_collect_HitQueue(HitCollector *hc, U32 doc_num, float score) {
    /* add to the total number of hits */
    hc\->i++;
.PP
.Vb 9
\&    /* bail if the score doesn't exceed the minimum */
\&    if (score < hc->f) {
\&        return;
\&    }
\&    else {
\&        SV *element;
\&        char doc_num_buf[4];
\&        PriorityQueue *hit_queue;
\&        hit_queue = (PriorityQueue*)hc->storage;
.Ve
.PP
.Vb 8
\&        /* put a dualvar scalar -- encoded doc_num in PV, score in NV */ 
\&        element = sv_newmortal();
\&        (void)SvUPGRADE(element, SVt_PVNV);
\&        Kino_encode_bigend_U32(doc_num, &doc_num_buf);
\&        sv_setpvn(element, doc_num_buf, (STRLEN)4);
\&        SvNV_set(element, (double)score);
\&        SvNOK_on(element);
\&        (void)Kino_PriQ_insert(hit_queue, element);
.Ve
.PP
.Vb 8
\&        /* store the bubble score in a more accessible spot */
\&        if (hit_queue->size == hit_queue->max_size) {
\&            SV *least_sv;
\&            least_sv = Kino_PriQ_peek(hit_queue);
\&            hc->f    = SvNV(least_sv);
\&        }
\&    }
\&}
.Ve
.PP
void
Kino_HC_collect_BitVec(HitCollector *hc, U32 doc_num, float score) {
    BitVector *bit_vec;
    bit_vec = (BitVector*)hc\->storage;
.PP
.Vb 2
\&    /* add to the total number of hits */
\&    hc->i++;
.Ve
.PP
.Vb 3
\&    /* add the doc_num to the BitVector */
\&    Kino_BitVec_set(bit_vec, doc_num);
\&}
.Ve
.PP
void
Kino_HC_collect_filtered(HitCollector *hc, U32 doc_num, float score) {
    if (hc\->filter_bits == \s-1NULL\s0) {
        Kino_confess(\*(L"filter_bits not set on FilteredCollector\*(R");
    }
.PP
.Vb 6
\&    if (Kino_BitVec_get(hc->filter_bits, doc_num)) {
\&        HitCollector *inner_collector;
\&        inner_collector = (HitCollector*)hc->storage;
\&        inner_collector->collect(inner_collector, doc_num, score);
\&    }
\&}
.Ve
.PP
void
Kino_HC_collect_offset(HitCollector *hc, U32 doc_num, float score) {
    HitCollector *inner_collector = (HitCollector*)hc\->storage;
    U32 offset_doc_num = doc_num + hc\->f;
    inner_collector\->collect(inner_collector, offset_doc_num, score);
}
.PP
void
Kino_HC_destroy(HitCollector *hc) {
    SvREFCNT_dec(hc\->storage_ref);
    SvREFCNT_dec(hc\->filter_bits_ref);
    Kino_Safefree(hc);
}
.PP
_\|_POD_\|_