view release on metacpan or  search on metacpan

lib/Acme/Bitfield.pod  view on Meta::CPAN

* Byte 0, Bit 0 (0x80) -> Index 0 * Byte 0, Bit 7 (0x01) -> Index 7 * Byte 1, Bit 0 (0x80) -> Index 8

This is the inverse of Perl's internal C<vec> bit-ordering, and this module handles the necessary bit-swizzling
transparently.

=head1 METHODS

=head2 C<get( $index )>

Returns 1 if the bit at C<$index> is set, 0 otherwise.

=head2 C<set( $index )>

Sets the bit at C<$index> to 1.

=head2 C<clear( $index )>

Sets the bit at C<$index> to 0.

=head2 C<count( )>

Returns the total number of bits set to 1.

=head2 C<is_full( )>

Returns true if all bits are set to 1.

=head2 C<is_empty( )>

Returns true if all bits are set to 0.

=head2 C<size( )>

Returns the total capacity of the bitfield.

=head2 C<data( )>

Returns the raw binary string representation of the bitfield.

=head2 C<set_data( $string )>

Sets the raw binary representation. The input string will be truncated or padded to match the C<size>, and any excess
bits in the last byte will be zeroed.

=head2 C<fill( )>

Sets all bits within the C<size> to 1.

=head2 C<find_missing( )>

Returns the index of the first bit set to 0, or C<undef> if all bits are set.

=head2 C<inverse( )>

Returns a new bitfield object with all bits within the C<size> inverted. Bit 0 becomes 1, and 1 becomes 0.

=head2 C<union( $other )>

Returns a new bitfield object representing the bitwise OR of this bitfield and C<$other>.

=head2 C<intersection( $other )>

Returns a new bitfield object representing the bitwise AND of this bitfield and C<$other>.

=head2 C<difference( $other )>

Returns a new bitfield object representing the bits set in this bitfield but NOT in C<$other> (bitwise AND NOT).

=head1 AUTHOR

Sanko Robinson E<lt>sanko@cpan.orgE<gt>

=head1 COPYRIGHT

Copyright (C) 2026 by Sanko Robinson.

This library is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0.

=cut