Class BitSequence (2.16.0)

Version latest

• 2.16.0 (latest)
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

BitSequence(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A sequence of bits, encoded in a byte array.

Each byte in the bitmap byte array stores 8 bits of the sequence. The only exception is the last byte, which may store 8 or fewer bits. The padding defines the number of bits of the last byte to be ignored as "padding". The values of these "padding" bits are unspecified and must be ignored.

To retrieve the first bit, bit 0, calculate: (bitmap[0] & 0x01) != 0. To retrieve the second bit, bit 1, calculate: (bitmap[0] & 0x02) != 0. To retrieve the third bit, bit 2, calculate: (bitmap[0] & 0x04) != 0. To retrieve the fourth bit, bit 3, calculate: (bitmap[0] & 0x08) != 0. To retrieve bit n, calculate: (bitmap[n / 8] & (0x01 << (n % 8))) != 0.

The "size" of a BitSequence (the number of bits it contains) is calculated by this formula: (bitmap.length * 8) - padding.

Attributes
Name	Description
bitmap	bytes The bytes that encode the bit sequence. May have a length of zero.
padding	int The number of bits of the last byte in bitmap to ignore as "padding". If the length of bitmap is zero, then this value must be 0. Otherwise, this value must be between 0 and 7, inclusive.