.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" 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 "Lucy::Object::BitVector 3pm"
.TH Lucy::Object::BitVector 3pm "2017-08-02" "perl v5.26.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"
Lucy::Object::BitVector \- An array of bits.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&    my $bit_vec = Lucy::Object::BitVector\->new( capacity => 8 );
\&    my $other   = Lucy::Object::BitVector\->new( capacity => 8 );
\&    $bit_vec\->set($_) for ( 0, 2, 4, 6 );
\&    $other\->set($_)   for ( 1, 3, 5, 7 );
\&    $bit_vec\->or($other);
\&    print "$_\en" for @{ $bit_vec\->to_array };    # prints 0 through 7.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
BitVector is a growable array of bits.  All bits are initially zero.
.SH "CONSTRUCTORS"
.IX Header "CONSTRUCTORS"
.SS "new( \fI[labeled params]\fP )"
.IX Subsection "new( [labeled params] )"
.Vb 3
\&    my $bit_vec = Lucy::Object::BitVector\->new( 
\&        capacity => $doc_max + 1,   # default 0,
\&    );
.Ve
.IP "\(bu" 4
\&\fBcapacity\fR \- The number of bits that the initial array should be
able to hold.
.SH "METHODS"
.IX Header "METHODS"
.SS "get(tick)"
.IX Subsection "get(tick)"
Return true if the bit at \f(CW\*(C`tick\*(C'\fR has been set, false if it
hasn't (regardless of whether it lies within the bounds of the
object's capacity).
.IP "\(bu" 4
\&\fBtick\fR \- The requested bit.
.SS "set(tick)"
.IX Subsection "set(tick)"
Set the bit at \f(CW\*(C`tick\*(C'\fR to 1.
.IP "\(bu" 4
\&\fBtick\fR \- The bit to be set.
.SS "clear(tick)"
.IX Subsection "clear(tick)"
Clear the indicated bit. (i.e. set it to 0).
.IP "\(bu" 4
\&\fBtick\fR \- The bit to be cleared.
.SS "\fIclear_all()\fP"
.IX Subsection "clear_all()"
Clear all bits.
.SS "and(other)"
.IX Subsection "and(other)"
Modify the BitVector so that only bits which remain set are those
which 1) were already set in this BitVector, and 2) were also set in
the other BitVector.
.IP "\(bu" 4
\&\fBother\fR \- Another BitVector.
.SS "or(other)"
.IX Subsection "or(other)"
Modify the BitVector, setting all bits which are set in the other
BitVector if they were not already set.
.IP "\(bu" 4
\&\fBother\fR \- Another BitVector.
.SS "and_not(other)"
.IX Subsection "and_not(other)"
Modify the BitVector, clearing all bits which are set in the other.
.IP "\(bu" 4
\&\fBother\fR \- Another BitVector.
.SS "xor(other)"
.IX Subsection "xor(other)"
Modify the BitVector, performing an \s-1XOR\s0 operation against the other.
.IP "\(bu" 4
\&\fBother\fR \- Another BitVector.
.SS "flip(tick)"
.IX Subsection "flip(tick)"
Invert the value of a bit.
.IP "\(bu" 4
\&\fBtick\fR \- The bit to invert.
.SS "flip_block( \fI[labeled params]\fP )"
.IX Subsection "flip_block( [labeled params] )"
Invert each bit within a contiguous block.
.IP "\(bu" 4
\&\fBoffset\fR \- Lower bound.
.IP "\(bu" 4
\&\fBlength\fR \- The number of bits to flip.
.SS "next_hit(tick)"
.IX Subsection "next_hit(tick)"
Returns the next set bit equal to or greater than \f(CW\*(C`tick\*(C'\fR,
or \-1 if no such bit exists.
.SS "\fIto_array()\fP"
.IX Subsection "to_array()"
Return an array where each element represents a set bit.
.SS "grow(capacity)"
.IX Subsection "grow(capacity)"
If the BitVector does not already have enough room to hold the
indicated number of bits, allocate more memory so that it can.
.IP "\(bu" 4
\&\fBcapacity\fR \- Least number of bits the BitVector should accomodate.
.SS "\fIcount()\fP"
.IX Subsection "count()"
Return a count of the number of set bits.
.SH "INHERITANCE"
.IX Header "INHERITANCE"
Lucy::Object::BitVector isa Lucy::Object::Obj.