Marvin Humphrey > KinoSearch-0.315 > KinoSearch::Object::BitVector

Download:
KinoSearch-0.315.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  4
View/Report Bugs
Source  

NAME ^

KinoSearch::Object::BitVector - An array of bits.

DEPRECATED ^

The KinoSearch code base has been assimilated by the Apache Lucy project. The "KinoSearch" namespace has been deprecated, but development continues under our new name at our new home: http://lucy.apache.org/

SYNOPSIS ^

    my $bit_vec = KinoSearch::Object::BitVector->new( capacity => 8 );
    my $other   = KinoSearch::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 "$_\n" for @{ $bit_vec->to_array };    # prints 0 through 7.

DESCRIPTION ^

BitVector is a growable array of bits. All bits are initially zero.

CONSTRUCTORS ^

new( [labeled params] )

    my $bit_vec = KinoSearch::Object::BitVector->new( 
        capacity => $doc_max + 1,   # default 0,
    );

METHODS ^

get(tick)

Return true if the bit at tick has been set, false if it hasn't (regardless of whether it lies within the bounds of the object's capacity).

set(tick)

Set the bit at tick to 1.

clear(tick)

Clear the indicated bit. (i.e. set it to 0).

clear_all()

Clear all bits.

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.

or(other)

Modify the BitVector, setting all bits which are set in the other BitVector if they were not already set.

and_not(other)

Modify the BitVector, clearing all bits which are set in the other.

xor(other)

Modify the BitVector, performing an XOR operation against the other.

flip(tick)

Invert the value of a bit.

flip_block( [labeled params] )

Invert each bit within a contiguous block.

next_hit(tick)

Returns the next set bit equal to or greater than tick, or -1 if no such bit exists.

to_array()

Return an array where each element represents a set bit.

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.

count()

Return a count of the number of set bits.

INHERITANCE ^

KinoSearch::Object::BitVector isa KinoSearch::Object::Obj.

COPYRIGHT AND LICENSE ^

Copyright 2005-2011 Marvin Humphrey

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: