QBitArray — PyQt Documentation v6.9.0 (original) (raw)
PyQt6.QtCore.QBitArray
Description¶
The QBitArray class provides an array of bits.
A QBitArray is an array that gives access to individual bits and provides operators (AND, OR, XOR, and NOT) that work on entire arrays of bits. It uses implicit sharing (copy-on-write) to reduce memory usage and to avoid the needless copying of data.
The following code constructs a QBitArray containing 200 bits initialized to false (0):
To initialize the bits to true, either pass true as second argument to the constructor, or call fill() later on.
QBitArray uses 0-based indexes, just like C++ arrays. To access the bit at a particular index position, you can use operator[](). On non-const bit arrays, operator[]() returns a reference to a bit that can be used on the left side of an assignment. For example:
QBitArray ba;
ba.resize(3);
ba[0] = true;
ba[1] = false;
ba[2] = true;
For technical reasons, it is more efficient to use testBit() and setBit() to access bits in the array than operator[](). For example:
QBitArray ba(3);
ba.setBit(0, true);
ba.setBit(1, false);
ba.setBit(2, true);
QBitArray supports & (AND), | (OR), ^ (XOR), ~ (NOT), as well as &=, |=, and ^=. These operators work in the same way as the built-in C++ bitwise operators of the same name. For example:
QBitArray x(5);
x.setBit(3, true);
// x: [ 0, 0, 0, 1, 0 ]
QBitArray y(5);
y.setBit(4, true);
// y: [ 0, 0, 0, 0, 1 ]
x |= y;
// x: [ 0, 0, 0, 1, 1 ]
For historical reasons, QBitArray distinguishes between a null bit array and an empty bit array. A null bit array is a bit array that is initialized using QBitArray’s default constructor. An empty bit array is any bit array with size 0. A null bit array is always empty, but an empty bit array isn’t necessarily null:
QBitArray().isNull(); // returns true
QBitArray().isEmpty(); // returns true
QBitArray(0).isNull(); // returns false
QBitArray(0).isEmpty(); // returns true
QBitArray(3).isNull(); // returns false
QBitArray(3).isEmpty(); // returns false
All functions except isNull() treat null bit arrays the same as empty bit arrays; for example, QBitArray compares equal to QBitArray(0). We recommend that you always use isEmpty() and avoid isNull().
Methods¶
__init__()
Constructs an empty bit array.
__init__(QBitArray)
Constructs a copy of other.
This operation takes constant time, because QBitArray is implicitly shared. This makes returning a QBitArray from a function very fast. If a shared instance is modified, it will be copied (copy-on-write), and that takes linear time.
__init__(int, value: bool = False)
Constructs a bit array containing size bits. The bits are initialized with value, which defaults to false (0).
__and__(QBitArray) → QBitArray
TODO
at(int) → bool
Returns the value of the bit at index position i.
i must be a valid index position in the bit array (i.e., 0 <= i < size()).
bits() → bytes
Returns a pointer to a dense bit array for this QBitArray. Bits are counted upwards from the least significant bit in each byte. The number of bits relevant in the last byte is given by size() % 8.
See also
clear()
Clears the contents of the bit array and makes it empty.
See also
clearBit(int)
Sets the bit at index position i to 0.
i must be a valid index position in the bit array (i.e., 0 <= i < size()).
See also
count() → int
Same as size().
count(bool) → int
If on is true, this function returns the number of 1-bits stored in the bit array; otherwise the number of 0-bits is returned.
detach()
TODO
__eq__(QBitArray) → bool
TODO
fill(bool, size: int = -1) → bool
Sets every bit in the bit array to value, returning true if successful; otherwise returns false. If size is different from -1 (the default), the bit array is resized to size beforehand.
Example:
QBitArray ba(8);
ba.fill(true);
// ba: [ 1, 1, 1, 1, 1, 1, 1, 1 ]
ba.fill(false, 2);
// ba: [ 0, 0 ]
fill(bool, int, int)
This is an overloaded function.
Sets bits at index positions begin up to (but not including) end to value.
begin must be a valid index position in the bit array (0 <= begin < size()).
end must be either a valid index position or equal to size(), in which case the fill operation runs until the end of the array (0 <= end <= size()).
Example:
QBitArray ba(4);
ba.fill(true, 1, 2); // ba: [ 0, 1, 0, 0 ]
ba.fill(true, 1, 3); // ba: [ 0, 1, 1, 0 ]
ba.fill(true, 1, 4); // ba: [ 0, 1, 1, 1 ]
@staticmethod
fromBits(bytes, int) → QBitArray
Creates a QBitArray with the dense bit array located at data, with size bits. The byte array at data must be at least size / 8 (rounded up) bytes long.
If size is not a multiple of 8, this function will include the lowest size % 8 bits from the last byte in data.
__getitem__(int) → bool
TODO
__hash__() → int
TODO
__iand__(QBitArray) → QBitArray
TODO
__ior__(QBitArray) → QBitArray
TODO
isDetached() → bool
TODO
isEmpty() → bool
Returns true if this bit array has size 0; otherwise returns false.
isNull() → bool
Returns true if this bit array is null; otherwise returns false.
Example:
QBitArray().isNull(); // returns true
QBitArray(0).isNull(); // returns false
QBitArray(3).isNull(); // returns false
Qt makes a distinction between null bit arrays and empty bit arrays for historical reasons. For most applications, what matters is whether or not a bit array contains any data, and this can be determined using isEmpty().
__ixor__(QBitArray) → QBitArray
TODO
__len__() → int
TODO
__ne__(QBitArray) → bool
TODO
TODO
resize(int)
Resizes the bit array to size bits.
If size is greater than the current size, the bit array is extended to make it size bits with the extra bits added to the end. The new bits are initialized to false (0).
If size is less than the current size, bits are removed from the end.
setBit(int)
Sets the bit at index position i to 1.
i must be a valid index position in the bit array (i.e., 0 <= i < size()).
See also
setBit(int, bool)
This is an overloaded function.
Sets the bit at index position i to value.
size() → int
Returns the number of bits stored in the bit array.
swap(QBitArray)
Swaps this bit array with other. This operation is very fast and never fails.
testBit(int) → bool
Returns true if the bit at index position i is 1; otherwise returns false.
i must be a valid index position in the bit array (i.e., 0 <= i < size()).
See also
toggleBit(int) → bool
Inverts the value of the bit at index position i, returning the previous value of that bit as either true (if it was set) or false (if it was unset).
If the previous value was 0, the new value will be 1. If the previous value was 1, the new value will be 0.
i must be a valid index position in the bit array (i.e., 0 <= i < size()).
See also
toUInt32(Endian) → (int, bool)
Returns the array of bit converted to an int. The conversion is based on endianness. Converts up to the first 32 bits of the array to quint32 and returns it, obeying endianness. If ok is not a null pointer, and the array has more than 32 bits, ok is set to false and this function returns zero; otherwise, it’s set to true.
truncate(int)
Truncates the bit array at index position pos.
If pos is beyond the end of the array, nothing happens.
__xor__(QBitArray) → QBitArray
TODO