Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
\inmodule QtCore More...
#include <qbitarray.h>
Public Types | |
typedef QByteArray::DataPointer | DataPtr |
Public Member Functions | |
QBitArray () noexcept | |
Constructs an empty bit array. | |
QBitArray (qsizetype size, bool val=false) | |
Constructs a bit array containing size bits. | |
void | swap (QBitArray &other) noexcept |
qsizetype | size () const |
Returns the number of bits stored in the bit array. | |
qsizetype | count () const |
Same as size(). | |
qsizetype | count (bool on) const |
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. | |
bool | isEmpty () const |
Returns true if this bit array has size 0; otherwise returns false. | |
bool | isNull () const |
Returns true if this bit array is null; otherwise returns false . | |
void | resize (qsizetype size) |
Resizes the bit array to size bits. | |
void | detach () |
bool | isDetached () const |
void | clear () |
Clears the contents of the bit array and makes it empty. | |
bool | testBit (qsizetype i) const |
Returns true if the bit at index position i is 1; otherwise returns false . | |
void | setBit (qsizetype i) |
Sets the bit at index position i to 1. | |
void | setBit (qsizetype i, bool val) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the bit at index position i to value. | |
void | clearBit (qsizetype i) |
Sets the bit at index position i to 0. | |
bool | toggleBit (qsizetype i) |
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). | |
bool | at (qsizetype i) const |
Returns the value of the bit at index position i. | |
QBitRef | operator[] (qsizetype i) |
Returns the bit at index position i as a modifiable reference. | |
bool | operator[] (qsizetype i) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QBitArray & | operator&= (QBitArray &&) |
Performs the AND operation between all bits in this bit array and other. | |
QBitArray & | operator|= (QBitArray &&) |
Performs the OR operation between all bits in this bit array and other. | |
QBitArray & | operator^= (QBitArray &&) |
Performs the XOR operation between all bits in this bit array and other. | |
QBitArray & | operator&= (const QBitArray &) |
QBitArray & | operator|= (const QBitArray &) |
QBitArray & | operator^= (const QBitArray &) |
bool | fill (bool aval, qsizetype asize=-1) |
Sets every bit in the bit array to value, returning true if successful; otherwise returns false . | |
void | fill (bool val, qsizetype first, qsizetype last) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets bits at index positions begin up to (but not including) end to value. | |
void | truncate (qsizetype pos) |
Truncates the bit array at index position pos. | |
const char * | bits () const |
quint32 | toUInt32 (QSysInfo::Endian endianness, bool *ok=nullptr) const noexcept |
DataPtr & | data_ptr () |
const DataPtr & | data_ptr () const |
Static Public Member Functions | |
static QBitArray | fromBits (const char *data, qsizetype len) |
Friends | |
Q_CORE_EXPORT friend QBitArray | operator& (const QBitArray &a1, const QBitArray &a2) |
QBitArray | operator& (QBitArray &&a1, const QBitArray &a2) |
QBitArray | operator& (const QBitArray &a1, QBitArray &&a2) |
QBitArray | operator& (QBitArray &&a1, QBitArray &&a2) |
Returns a bit array that is the AND of the bit arrays a1 and a2. | |
Q_CORE_EXPORT friend QBitArray | operator| (const QBitArray &a1, const QBitArray &a2) |
QBitArray | operator| (QBitArray &&a1, const QBitArray &a2) |
QBitArray | operator| (const QBitArray &a1, QBitArray &&a2) |
QBitArray | operator| (QBitArray &&a1, QBitArray &&a2) |
Returns a bit array that is the OR of the bit arrays a1 and a2. | |
Q_CORE_EXPORT friend QBitArray | operator^ (const QBitArray &a1, const QBitArray &a2) |
QBitArray | operator^ (QBitArray &&a1, const QBitArray &a2) |
QBitArray | operator^ (const QBitArray &a1, QBitArray &&a2) |
QBitArray | operator^ (QBitArray &&a1, QBitArray &&a2) |
Returns a bit array that is the XOR of the bit arrays a1 and a2. | |
Q_CORE_EXPORT QDataStream & | operator<< (QDataStream &, const QBitArray &) |
Writes bit array ba to stream out. | |
Q_CORE_EXPORT QDataStream & | operator>> (QDataStream &, QBitArray &) |
Reads a bit array into ba from stream in. | |
Q_CORE_EXPORT size_t | qHash (const QBitArray &key, size_t seed=0) |
QBitArray | operator~ (QBitArray a) |
Returns a bit array that contains the inverted bits of the bit array a. | |
bool | comparesEqual (const QBitArray &lhs, const QBitArray &rhs) noexcept |
\inmodule QtCore
The QBitArray class provides an array of bits.
\reentrant
\compares equality
A QBitArray is an array that gives access to individual bits and provides operators (\l{operator&()}{AND}, \l{operator|()}{OR}, \l{operator^()}{XOR}, and \l{operator~()}{NOT}) that work on entire arrays of bits. It uses \l{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:
For technical reasons, it is more efficient to use testBit() and setBit() to access bits in the array than operator[](). For example:
QBitArray supports {&} (\l{operator&()}{AND}),
{|} (\l{operator|()}{OR}),
{^} (\l{operator^()}{XOR}),
{~} (\l{operator~()}{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:
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:
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().
Definition at line 12 of file qbitarray.h.
Definition at line 136 of file qbitarray.h.
|
inlinenoexcept |
Constructs a bit array containing size bits.
The bits are initialized with value, which defaults to false (0).
Definition at line 139 of file qbitarray.cpp.
|
inline |
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()).
Definition at line 105 of file qbitarray.h.
|
inline |
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}.
Definition at line 130 of file qbitarray.h.
|
inline |
Clears the contents of the bit array and makes it empty.
Definition at line 87 of file qbitarray.h.
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()).
Definition at line 95 of file qbitarray.h.
|
inline |
Same as size().
Definition at line 77 of file qbitarray.h.
qsizetype QBitArray::count | ( | bool | on | ) | const |
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.
Definition at line 166 of file qbitarray.cpp.
|
inline |
Definition at line 137 of file qbitarray.h.
|
inline |
Definition at line 138 of file qbitarray.h.
|
inline |
Definition at line 85 of file qbitarray.h.
|
inline |
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:
Definition at line 124 of file qbitarray.h.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.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:
Definition at line 271 of file qbitarray.cpp.
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.
Definition at line 309 of file qbitarray.cpp.
|
inline |
Definition at line 86 of file qbitarray.h.
|
inline |
Returns true
if this bit array has size 0; otherwise returns false.
Definition at line 80 of file qbitarray.h.
|
inline |
Returns true
if this bit array is null; otherwise returns false
.
Example:
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().
Definition at line 81 of file qbitarray.h.
Definition at line 665 of file qbitarray.cpp.
Performs the AND operation between all bits in this bit array and other.
Assigns the result to this bit array, and returns a reference to it.
The result has the length of the longest of the two bit arrays, with any missing bits (if one array is shorter than the other) taken to be 0.
Example:
Definition at line 660 of file qbitarray.cpp.
Returns the bit at index position i as a modifiable reference.
i must be a valid index position in the bit array (i.e., 0 <= i < size()).
Example:
The return value is of type QBitRef, a helper class for QBitArray. When you get an object of type QBitRef, you can assign to it, and the assignment will apply to the bit in the QBitArray from which you got the reference.
The functions testBit(), setBit(), and clearBit() are slightly faster.
Definition at line 163 of file qbitarray.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 107 of file qbitarray.h.
Definition at line 721 of file qbitarray.cpp.
Performs the XOR operation between all bits in this bit array and other.
Assigns the result to this bit array, and returns a reference to it.
The result has the length of the longest of the two bit arrays, with any missing bits (if one array is shorter than the other) taken to be 0.
Example:
Definition at line 716 of file qbitarray.cpp.
Definition at line 693 of file qbitarray.cpp.
Performs the OR operation between all bits in this bit array and other.
Assigns the result to this bit array, and returns a reference to it.
The result has the length of the longest of the two bit arrays, with any missing bits (if one array is shorter than the other) taken to be 0.
Example:
Definition at line 688 of file qbitarray.cpp.
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.
Definition at line 208 of file qbitarray.cpp.
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()).
Definition at line 91 of file qbitarray.h.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the bit at index position i to value.
Definition at line 93 of file qbitarray.h.
|
inline |
Returns the number of bits stored in the bit array.
Definition at line 76 of file qbitarray.h.
Definition at line 74 of file qbitarray.h.
|
inline |
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()).
Definition at line 89 of file qbitarray.h.
|
inline |
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()).
Definition at line 97 of file qbitarray.h.
|
noexcept |
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.
Definition at line 332 of file qbitarray.cpp.
Truncates the bit array at index position pos.
If pos is beyond the end of the array, nothing happens.
Definition at line 128 of file qbitarray.h.
Definition at line 141 of file qbitarray.h.
Definition at line 787 of file qbitarray.cpp.
Definition at line 17 of file qbitarray.h.
Definition at line 15 of file qbitarray.h.
Returns a bit array that is the AND of the bit arrays a1 and a2.
The result has the length of the longest of the two bit arrays, with any missing bits (if one array is shorter than the other) taken to be 0.
Example:
Definition at line 19 of file qbitarray.h.
|
friend |
Writes bit array ba to stream out.
Definition at line 900 of file qbitarray.cpp.
|
friend |
Reads a bit array into ba from stream in.
Definition at line 925 of file qbitarray.cpp.
Definition at line 839 of file qbitarray.cpp.
Definition at line 33 of file qbitarray.h.
Definition at line 31 of file qbitarray.h.
Returns a bit array that is the XOR of the bit arrays a1 and a2.
The result has the length of the longest of the two bit arrays, with any missing bits (if one array is shorter than the other) taken to be 0.
Example:
Definition at line 35 of file qbitarray.h.
Definition at line 813 of file qbitarray.cpp.
Definition at line 25 of file qbitarray.h.
Definition at line 23 of file qbitarray.h.
Returns a bit array that is the OR of the bit arrays a1 and a2.
The result has the length of the longest of the two bit arrays, with any missing bits (if one array is shorter than the other) taken to be 0.
Example:
Definition at line 27 of file qbitarray.h.
Returns a bit array that contains the inverted bits of the bit array a.
Example:
Definition at line 43 of file qbitarray.h.
|
friend |