.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "Plucene::Index::SegmentReader 3pm"
.TH Plucene::Index::SegmentReader 3pm "2022-12-04" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Plucene::Index::SegmentReader \- the Segment reader
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        my $seg_reader = 
\&          Plucene::Index::SegmentReader\->new( Plucene::Index::SegmentInfo $si);
\&
\&        my @files = $seg_reader\->files;
\&        my @terms = $seg_reader\->terms;
\&        my $doc = $seg_reader\->document($id);
\&        my $doc_freq = $seg_reader\->doc_freq($term);
\&        my $max_doc = $seg_reader\->max_doc;
\&        my $norms = $seg_reader\->norms($field, $offset);
\&        
\&        my Plucene::Index::SegmentTermDocs $docs 
\&                = $seg_reader\->term_docs($term);
\&        
\&        my Plucene::Index::SegmentTermPositions $pos 
\&                = $seg_reader\->term_positions($term);
\&                
\&        my Plucene::Store::InputStream $stream 
\&                = $seg_reader\->norm_stream($field);
\&                
\&        if ($seg_reader\->is_deleted($id)) {  .. }
\&        if ($seg_reader\->has_deletions(Plucene::Index::SegmentInfo $si)) 
\&                {  ... }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The segment reader class.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 2
\&        my $seg_reader = 
\&          Plucene::Index::SegmentReader\->new( Plucene::Index::SegmentInfo $si);
.Ve
.PP
This will create a new Plucene::Index::SegmentReader object.
.SS "has_deletions"
.IX Subsection "has_deletions"
.Vb 2
\&        if ($seg_reader\->has_deletions(Plucene::Index::SegmentInfo $si)) 
\&                {  ... }
.Ve
.SS "files"
.IX Subsection "files"
.Vb 1
\&        my @files = $seg_reader\->files;
.Ve
.SS "terms"
.IX Subsection "terms"
.Vb 1
\&        my @terms = $seg_reader\->terms;
.Ve
.SS "document"
.IX Subsection "document"
.Vb 1
\&        my $doc = $seg_reader\->document($id);
.Ve
.SS "is_deleted"
.IX Subsection "is_deleted"
.Vb 1
\&        if ($seg_reader\->is_deleted($id)) {  .. }
.Ve
.SS "term_docs"
.IX Subsection "term_docs"
.Vb 2
\&        my Plucene::Index::SegmentTermDocs $docs 
\&                = $seg_reader\->term_docs($term);
.Ve
.PP
This will return the Plucene::Index::SegmentTermDocs object for the
given term.
.SS "term_positions"
.IX Subsection "term_positions"
.Vb 2
\&        my Plucene::Index::SegmentTermPositions $pos 
\&                = $seg_reader\->term_positions($term);
.Ve
.PP
This will return the Plucene::Index::SegmentTermPositions object for the
given term.
.SS "doc_freq"
.IX Subsection "doc_freq"
.Vb 1
\&        my $doc_freq = $seg_reader\->doc_freq($term);
.Ve
.PP
This returns the number of documents containing the passed term.
.SS "num_docs"
.IX Subsection "num_docs"
.Vb 1
\&        my $num_docs = $seg_reader\->num_docs;
.Ve
.PP
This is the number of documents, excluding deleted ones.
.SS "max_doc"
.IX Subsection "max_doc"
.Vb 1
\&        my $max_doc = $seg_reader\->max_doc;
.Ve
.SS "norms"
.IX Subsection "norms"
.Vb 1
\&        my $norms = $seg_reader\->norms($field, $offset);
.Ve
.PP
This returns the byte-encoded normalisation factor for the passed
field. This is used by the search code to score documents.
.PP
Note we are not using the 'offset' and 'bytes' arguments per the Java.
Instead, callers should use substr to put the result of \*(L"norms\*(R" into 
the appropriate place in a string.
.SS "norm_stream"
.IX Subsection "norm_stream"
.Vb 2
\&        my Plucene::Store::InputStream $stream 
\&                = $seg_reader\->norm_stream($field);
.Ve
.PP
This will return the Plucene::Store::InputStream for the passed field.