{"author":"Ilan Schnell","author_email":"ilanschnell@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 6 - Mature","Intended Audience :: Developers","Operating System :: OS Independent","Programming Language :: C","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.6","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Utilities"],"description":"bitarray: efficient arrays of booleans\n======================================\n\nThis library provides an object type which efficiently represents an array\nof booleans. Bitarrays are sequence types and behave very much like usual\nlists. Eight bits are represented by one byte in a contiguous block of\nmemory. The user can select between two representations: little-endian\nand big-endian. All functionality is implemented in C.\nMethods for accessing the machine representation are provided, including the\nability to import and export buffers. This allows creating bitarrays that\nare mapped to other objects, including memory-mapped files.\n\n\nKey features\n------------\n\n* The bit-endianness can be specified for each bitarray object, see below.\n* Sequence methods: slicing (including slice assignment and deletion),\n operations ``+``, ``*``, ``+=``, ``*=``, the ``in`` operator, ``len()``\n* Bitwise operations: ``~``, ``&``, ``|``, ``^``, ``<<``, ``>>`` (as well as\n their in-place versions ``&=``, ``|=``, ``^=``, ``<<=``, ``>>=``).\n* Fast methods for encoding and decoding variable bit length prefix codes.\n* Bitarray objects support the buffer protocol (both importing and\n exporting buffers).\n* Packing and unpacking to other binary data formats, e.g. ``numpy.ndarray``.\n* Pickling and unpickling of bitarray objects.\n* Immutable ``frozenbitarray`` objects which are hashable\n* Sequential search\n* Type hinting\n* Extensive test suite with over 500 unittests\n* Utility module ``bitarray.util``:\n\n * conversion to and from hexadecimal strings\n * (de-) serialization\n * pretty printing\n * conversion to and from integers\n * creating Huffman codes\n * compression of sparse bitarrays\n * various count functions\n * other helpful functions\n\n\nInstallation\n------------\n\nPython wheels are are available on PyPI for all mayor platforms and Python\nversions. Which means you can simply:\n\n.. code-block:: shell-session\n\n $ pip install bitarray\n\nIn addition, conda packages are available (both the default Anaconda\nrepository as well as conda-forge support bitarray):\n\n.. code-block:: shell-session\n\n $ conda install bitarray\n\nOnce you have installed the package, you may want to test it:\n\n.. code-block:: shell-session\n\n $ python -c 'import bitarray; bitarray.test()'\n bitarray is installed in: /Users/ilan/bitarray/bitarray\n bitarray version: 3.4.2\n sys.version: 3.10.14 (main, Mar 20 2024) [Clang 16.0.6]\n sys.prefix: /Users/ilan/miniforge3\n pointer size: 64 bit\n sizeof(size_t): 8\n sizeof(bitarrayobject): 80\n HAVE_BUILTIN_BSWAP64: 1\n default bit-endianness: big\n machine byte-order: little\n DEBUG: 0\n .........................................................................\n .........................................................................\n ................................................................\n ----------------------------------------------------------------------\n Ran 565 tests in 0.191s\n\n OK\n\nThe ``test()`` function is part of the API. It will return\na ``unittest.runner.TextTestResult`` object, such that one can verify that\nall tests ran successfully by:\n\n.. code-block:: python\n\n import bitarray\n assert bitarray.test().wasSuccessful()\n\n\nUsage\n-----\n\nAs mentioned above, bitarray objects behave very much like lists, so\nthere is not too much to learn. The biggest difference from list\nobjects (except that bitarray are obviously homogeneous) is the ability\nto access the machine representation of the object.\nWhen doing so, the bit-endianness is of importance; this issue is\nexplained in detail in the section below. Here, we demonstrate the\nbasic usage of bitarray objects:\n\n.. code-block:: python\n\n >>> from bitarray import bitarray\n >>> a = bitarray() # create empty bitarray\n >>> a.append(1)\n >>> a.extend([1, 0])\n >>> a\n bitarray('110')\n >>> x = bitarray(2 ** 20) # bitarray of length 1048576 (initialized to 0)\n >>> len(x)\n 1048576\n >>> bitarray('1001 011') # initialize from string (whitespace is ignored)\n bitarray('1001011')\n >>> lst = [1, 0, False, True, True]\n >>> a = bitarray(lst) # initialize from iterable\n >>> a\n bitarray('10011')\n >>> a[2] # indexing a single item will always return an integer\n 0\n >>> a[2:4] # whereas indexing a slice will always return a bitarray\n bitarray('01')\n >>> a[2:3] # even when the slice length is just one\n bitarray('0')\n >>> a.count(1)\n 3\n >>> a.remove(0) # removes first occurrence of 0\n >>> a\n bitarray('1011')\n\nLike lists, bitarray objects support slice assignment and deletion:\n\n.. code-block:: python\n\n >>> a = bitarray(50)\n >>> a.setall(0) # set all elements in a to 0\n >>> a[11:37:3] = 9 * bitarray('1')\n >>> a\n bitarray('00000000000100100100100100100100100100000000000000')\n >>> del a[12::3]\n >>> a\n bitarray('0000000000010101010101010101000000000')\n >>> a[-6:] = bitarray('10011')\n >>> a\n bitarray('000000000001010101010101010100010011')\n >>> a += bitarray('000111')\n >>> a[9:]\n bitarray('001010101010101010100010011000111')\n\nIn addition, slices can be assigned to booleans, which is easier (and\nfaster) than assigning to a bitarray in which all values are the same:\n\n.. code-block:: python\n\n >>> a = 20 * bitarray('0')\n >>> a[1:15:3] = True\n >>> a\n bitarray('01001001001001000000')\n\nThis is easier and faster than:\n\n.. code-block:: python\n\n >>> a = 20 * bitarray('0')\n >>> a[1:15:3] = 5 * bitarray('1')\n >>> a\n bitarray('01001001001001000000')\n\nNote that in the latter we have to create a temporary bitarray whose length\nmust be known or calculated. Another example of assigning slices to Booleans,\nis setting ranges:\n\n.. code-block:: python\n\n >>> a = bitarray(30)\n >>> a[:] = 0 # set all elements to 0 - equivalent to a.setall(0)\n >>> a[10:25] = 1 # set elements in range(10, 25) to 1\n >>> a\n bitarray('000000000011111111111111100000')\n\nAs of bitarray version 2.8, indices may also be lists of arbitrary\nindices (like in NumPy), or bitarrays that are treated as masks,\nsee `Bitarray indexing `__.\n\n\nBitwise operators\n-----------------\n\nBitarray objects support the bitwise operators ``~``, ``&``, ``|``, ``^``,\n``<<``, ``>>`` (as well as their in-place versions ``&=``, ``|=``, ``^=``,\n``<<=``, ``>>=``). The behavior is very much what one would expect:\n\n.. code-block:: python\n\n >>> a = bitarray('101110001')\n >>> ~a # invert\n bitarray('010001110')\n >>> b = bitarray('111001011')\n >>> a ^ b\n bitarray('010111010')\n >>> a &= b\n >>> a\n bitarray('101000001')\n >>> a <<= 2 # in-place left shift by 2\n >>> a\n bitarray('100000100')\n >>> b >> 1\n bitarray('011100101')\n\nThe C language does not specify the behavior of negative shifts and\nof left shifts larger or equal than the width of the promoted left operand.\nThe exact behavior is compiler/machine specific.\nThis Python bitarray library specifies the behavior as follows:\n\n* the length of the bitarray is never changed by any shift operation\n* blanks are filled by 0\n* negative shifts raise ``ValueError``\n* shifts larger or equal to the length of the bitarray result in\n bitarrays with all values 0\n\nIt is worth noting that (regardless of bit-endianness) the bitarray left\nshift (``<<``) always shifts towards lower indices, and the right\nshift (``>>``) always shifts towards higher indices.\n\n\nBit-endianness\n--------------\n\nUnless explicitly converting to machine representation, i.e. initializing\nthe buffer directly, using ``.tobytes()``, ``.frombytes()``, ``.tofile()``\nor ``.fromfile()``, as well as using ``memoryview()``, the bit-endianness\nwill have no effect on any computation, and one can skip this section.\n\nSince bitarrays allows addressing individual bits, where the machine\nrepresents 8 bits in one byte, there are two obvious choices for this\nmapping: little-endian and big-endian.\n\nWhen dealing with the machine representation of bitarray objects, it is\nrecommended to always explicitly specify the endianness.\n\nBy default, bitarrays use big-endian representation:\n\n.. code-block:: python\n\n >>> a = bitarray(b'A')\n >>> a.endian\n 'big'\n >>> a\n bitarray('01000001')\n >>> a[6] = 1\n >>> a.tobytes()\n b'C'\n\nBig-endian means that the most-significant bit comes first.\nHere, ``a[0]`` is the lowest address (index) and most significant bit,\nand ``a[7]`` is the highest address and least significant bit.\n\nWhen creating a new bitarray object, the endianness can always be\nspecified explicitly:\n\n.. code-block:: python\n\n >>> a = bitarray(b'A', endian='little')\n >>> a\n bitarray('10000010')\n >>> a.endian\n 'little'\n\nHere, the low-bit comes first because little-endian means that increasing\nnumeric significance corresponds to an increasing address.\nSo ``a[0]`` is the lowest address and least significant bit,\nand ``a[7]`` is the highest address and most significant bit.\n\nThe bit-endianness is a property of the bitarray object.\nThe endianness cannot be changed once a bitarray object has been created.\nWhen comparing bitarray objects, the endianness (and hence the machine\nrepresentation) is irrelevant; what matters is the mapping from indices\nto bits:\n\n.. code-block:: python\n\n >>> bitarray('11001', endian='big') == bitarray('11001', endian='little')\n True\n >>> a = bitarray(b'\\x01', endian='little')\n >>> b = bitarray(b'\\x80', endian='big')\n >>> a == b\n True\n >>> a.tobytes() == b.tobytes()\n False\n\nBitwise operations (``|``, ``^``, ``&=``, ``|=``, ``^=``, ``~``) are\nimplemented efficiently using the corresponding byte operations in C, i.e. the\noperators act on the machine representation of the bitarray objects.\nTherefore, it is not possible to perform bitwise operators on bitarrays\nwith different endianness.\n\nAs mentioned above, the endianness can not be changed once an object is\ncreated. However, you can create a new bitarray with different endianness:\n\n.. code-block:: python\n\n >>> a = bitarray('111000', endian='little')\n >>> b = bitarray(a, endian='big')\n >>> b\n bitarray('111000')\n >>> a == b\n True\n\n\nBuffer protocol\n---------------\n\nBitarray objects support the buffer protocol. They can both export their\nown buffer, as well as import another object's buffer. To learn more about\nthis topic, please read `buffer protocol `__. There is also an example that shows how\nto memory-map a file to a bitarray: `mmapped-file.py `__\n\n\nVariable bit length prefix codes\n--------------------------------\n\nThe ``.encode()`` method takes a dictionary mapping symbols to bitarrays\nand an iterable, and extends the bitarray object with the encoded symbols\nfound while iterating. For example:\n\n.. code-block:: python\n\n >>> d = {'H':bitarray('111'), 'e':bitarray('0'),\n ... 'l':bitarray('110'), 'o':bitarray('10')}\n ...\n >>> a = bitarray()\n >>> a.encode(d, 'Hello')\n >>> a\n bitarray('111011011010')\n\nNote that the string ``'Hello'`` is an iterable, but the symbols are not\nlimited to characters, in fact any immutable Python object can be a symbol.\nTaking the same dictionary, we can apply the ``.decode()`` method which will\nreturn an iterable of the symbols:\n\n.. code-block:: python\n\n >>> list(a.decode(d))\n ['H', 'e', 'l', 'l', 'o']\n >>> ''.join(a.decode(d))\n 'Hello'\n\nSymbols are not limited to being characters.\nThe above dictionary ``d`` can be efficiently constructed using the function\n``bitarray.util.huffman_code()``. I also wrote `Huffman coding in Python\nusing bitarray `__ for more\nbackground information.\n\nWhen the codes are large, and you have many decode calls, most time will\nbe spent creating the (same) internal decode tree objects. In this case,\nit will be much faster to create a ``decodetree`` object, which can be\npassed to bitarray's ``.decode()`` method, instead of passing the prefix\ncode dictionary to those methods itself:\n\n.. code-block:: python\n\n >>> from bitarray import bitarray, decodetree\n >>> t = decodetree({'a': bitarray('0'), 'b': bitarray('1')})\n >>> a = bitarray('0110')\n >>> list(a.decode(t))\n ['a', 'b', 'b', 'a']\n\nThe sole purpose of the immutable ``decodetree`` object is to be passed\nto bitarray's ``.decode()`` method.\n\n\nFrozenbitarrays\n---------------\n\nA ``frozenbitarray`` object is very similar to the bitarray object.\nThe difference is that this a ``frozenbitarray`` is immutable, and hashable,\nand can therefore be used as a dictionary key:\n\n.. code-block:: python\n\n >>> from bitarray import frozenbitarray\n >>> key = frozenbitarray('1100011')\n >>> {key: 'some value'}\n {frozenbitarray('1100011'): 'some value'}\n >>> key[3] = 1\n Traceback (most recent call last):\n ...\n TypeError: frozenbitarray is immutable\n\n\nReference\n=========\n\nbitarray version: 3.4.2 -- `change log `__\n\nIn the following, ``item`` and ``value`` are usually a single bit -\nan integer 0 or 1.\n\nAlso, ``sub_bitarray`` refers to either a bitarray, or an ``item``.\n\n\nThe bitarray object:\n--------------------\n\n``bitarray(initializer=0, /, endian='big', buffer=None)`` -> bitarray\n Return a new bitarray object whose items are bits initialized from\n the optional initializer, and bit-endianness.\n The initializer may be one of the following types:\n a.) ``int`` bitarray, initialized to zeros, of given length\n b.) ``bytes`` or ``bytearray`` to initialize buffer directly\n c.) ``str`` of 0s and 1s, ignoring whitespace and \"_\"\n d.) iterable of integers 0 or 1.\n\n Optional keyword arguments:\n\n ``endian``: Specifies the bit-endianness of the created bitarray object.\n Allowed values are ``big`` and ``little`` (the default is ``big``).\n The bit-endianness effects the buffer representation of the bitarray.\n\n ``buffer``: Any object which exposes a buffer. When provided, ``initializer``\n cannot be present (or has to be ``None``). The imported buffer may be\n read-only or writable, depending on the object type.\n\n New in version 2.3: optional ``buffer`` argument\n\n New in version 3.4: allow initializer ``bytes`` or ``bytearray`` to set buffer directly\n\n\nbitarray methods:\n-----------------\n\n``all()`` -> bool\n Return True when all bits in bitarray are True.\n Note that ``a.all()`` is faster than ``all(a)``.\n\n\n``any()`` -> bool\n Return True when any bit in bitarray is True.\n Note that ``a.any()`` is faster than ``any(a)``.\n\n\n``append(item, /)``\n Append ``item`` to the end of the bitarray.\n\n\n``buffer_info()`` -> tuple\n Return a tuple containing:\n\n 0. memory address of buffer\n 1. buffer size (in bytes)\n 2. bit-endianness as a Unicode string\n 3. number of pad bits\n 4. allocated memory for the buffer (in bytes)\n 5. memory is read-only\n 6. buffer is imported\n 7. number of buffer exports\n\n\n``bytereverse(start=0, stop=, /)``\n For each byte in byte-range(start, stop) reverse bits in-place.\n The start and stop indices are given in terms of bytes (not bits).\n Also note that this method only changes the buffer; it does not change the\n bit-endianness of the bitarray object. Pad bits are left unchanged such\n that two consecutive calls will always leave the bitarray unchanged.\n\n New in version 2.2.5: optional start and stop arguments\n\n\n``clear()``\n Remove all items from the bitarray.\n\n New in version 1.4\n\n\n``copy()`` -> bitarray\n Return a copy of the bitarray.\n\n\n``count(value=1, start=0, stop=, step=1, /)`` -> int\n Number of occurrences of ``value`` bitarray within ``[start:stop:step]``.\n Optional arguments ``start``, ``stop`` and ``step`` are interpreted in\n slice notation, meaning ``a.count(value, start, stop, step)`` equals\n ``a[start:stop:step].count(value)``.\n The ``value`` may also be a sub-bitarray. In this case non-overlapping\n occurrences are counted within ``[start:stop]`` (``step`` must be 1).\n\n New in version 1.1.0: optional start and stop arguments\n\n New in version 2.3.7: optional step argument\n\n New in version 2.9: add non-overlapping sub-bitarray count\n\n\n``decode(code, /)`` -> iterator\n Given a prefix code (a dict mapping symbols to bitarrays, or ``decodetree``\n object), decode content of bitarray and return an iterator over\n corresponding symbols.\n\n See also: `Bitarray 3 transition `__\n\n New in version 3.0: returns iterator (equivalent to past ``.iterdecode()``)\n\n\n``encode(code, iterable, /)``\n Given a prefix code (a dict mapping symbols to bitarrays),\n iterate over the iterable object with symbols, and extend bitarray\n with corresponding bitarray for each symbol.\n\n\n``extend(iterable, /)``\n Append items from to the end of the bitarray.\n If ``iterable`` is a Unicode string, each ``0`` and ``1`` are appended as\n bits (ignoring whitespace and underscore).\n\n New in version 3.4: allow ``bytes`` object\n\n\n``fill()`` -> int\n Add zeros to the end of the bitarray, such that the length will be\n a multiple of 8, and return the number of bits added [0..7].\n\n\n``find(sub_bitarray, start=0, stop=, /, right=False)`` -> int\n Return lowest (or rightmost when ``right=True``) index where sub_bitarray\n is found, such that sub_bitarray is contained within ``[start:stop]``.\n Return -1 when sub_bitarray is not found.\n\n New in version 2.1\n\n New in version 2.9: add optional keyword argument ``right``\n\n\n``frombytes(bytes, /)``\n Extend bitarray with raw bytes from a bytes-like object.\n Each added byte will add eight bits to the bitarray.\n\n New in version 2.5.0: allow bytes-like argument\n\n\n``fromfile(f, n=-1, /)``\n Extend bitarray with up to ``n`` bytes read from file object ``f`` (or any\n other binary stream what supports a ``.read()`` method, e.g. ``io.BytesIO``).\n Each read byte will add eight bits to the bitarray. When ``n`` is omitted or\n negative, all bytes until EOF is reached. When ``n`` is non-negative but\n exceeds the data available, ``EOFError`` is raised (but the available data\n is still read and appended).\n\n\n``index(sub_bitarray, start=0, stop=, /, right=False)`` -> int\n Return lowest (or rightmost when ``right=True``) index where sub_bitarray\n is found, such that sub_bitarray is contained within ``[start:stop]``.\n Raises ``ValueError`` when the sub_bitarray is not present.\n\n New in version 2.9: add optional keyword argument ``right``\n\n\n``insert(index, value, /)``\n Insert ``value`` into bitarray before ``index``.\n\n\n``invert(index=, /)``\n Invert all bits in bitarray (in-place).\n When the optional ``index`` is given, only invert the single bit at index.\n\n New in version 1.5.3: optional index argument\n\n\n``pack(bytes, /)``\n Extend bitarray from a bytes-like object, where each byte corresponds\n to a single bit. The byte ``b'\\x00'`` maps to bit 0 and all other bytes\n map to bit 1.\n\n This method, as well as the ``.unpack()`` method, are meant for efficient\n transfer of data between bitarray objects to other Python objects (for\n example NumPy's ndarray object) which have a different memory view.\n\n New in version 2.5.0: allow bytes-like argument\n\n\n``pop(index=-1, /)`` -> item\n Remove and return item at ``index`` (default last).\n Raises ``IndexError`` if index is out of range.\n\n\n``remove(value, /)``\n Remove the first occurrence of ``value``.\n Raises ``ValueError`` if value is not present.\n\n\n``reverse()``\n Reverse all bits in bitarray (in-place).\n\n\n``search(sub_bitarray, start=0, stop=, /, right=False)`` -> iterator\n Return iterator over indices where sub_bitarray is found, such that\n sub_bitarray is contained within ``[start:stop]``.\n The indices are iterated in ascending order (from lowest to highest),\n unless ``right=True``, which will iterate in descending order (starting with\n rightmost match).\n\n See also: `Bitarray 3 transition `__\n\n New in version 2.9: optional start and stop arguments - add optional keyword argument ``right``\n\n New in version 3.0: returns iterator (equivalent to past ``.itersearch()``)\n\n\n``setall(value, /)``\n Set all elements in bitarray to ``value``.\n Note that ``a.setall(value)`` is equivalent to ``a[:] = value``.\n\n\n``sort(reverse=False)``\n Sort all bits in bitarray (in-place).\n\n\n``to01(group=0, sep=' ')`` -> str\n Return bitarray as Unicode string of '0's and '1's.\n The bits are grouped into ``group`` bits (default is no grouping).\n When grouped, the string ``sep`` is inserted between groups\n of ``group`` characters, default is a space.\n\n New in version 3.3: optional ``group`` and ``sep`` arguments\n\n\n``tobytes()`` -> bytes\n Return the bitarray buffer in bytes (pad bits are set to zero).\n\n\n``tofile(f, /)``\n Write byte representation of bitarray to file object f.\n\n\n``tolist()`` -> list\n Return bitarray as list of integers.\n ``a.tolist()`` equals ``list(a)``.\n\n Note that the list object being created will require 32 or 64 times more\n memory (depending on the machine architecture) than the bitarray object,\n which may cause a memory error if the bitarray is very large.\n\n\n``unpack(zero=b'\\x00', one=b'\\x01')`` -> bytes\n Return bytes that contain one byte for each bit in the bitarray,\n using specified mapping.\n\n\nbitarray data descriptors:\n--------------------------\n\nData descriptors were added in version 2.6.\n\n``endian`` -> str\n bit-endianness as Unicode string\n\n New in version 3.4: replaces former ``.endian()`` method\n\n\n``nbytes`` -> int\n buffer size in bytes\n\n\n``padbits`` -> int\n number of pad bits\n\n\n``readonly`` -> bool\n bool indicating whether buffer is read-only\n\n\nOther objects:\n--------------\n\n``frozenbitarray(initializer=0, /, endian='big', buffer=None)`` -> frozenbitarray\n Return a ``frozenbitarray`` object. Initialized the same way a ``bitarray``\n object is initialized. A ``frozenbitarray`` is immutable and hashable,\n and may therefore be used as a dictionary key.\n\n New in version 1.1\n\n\n``decodetree(code, /)`` -> decodetree\n Given a prefix code (a dict mapping symbols to bitarrays),\n create a binary tree object to be passed to ``.decode()``.\n\n New in version 1.6\n\n\nFunctions defined in the `bitarray` module:\n-------------------------------------------\n\n``bits2bytes(n, /)`` -> int\n Return the number of bytes necessary to store n bits.\n\n\n``get_default_endian()`` -> str\n Return the default bit-endianness for new bitarray objects being created.\n Unless ``_set_default_endian('little')`` was called, the default\n bit-endianness is ``big``.\n\n New in version 1.3\n\n\n``test(verbosity=1)`` -> TextTestResult\n Run self-test, and return unittest.runner.TextTestResult object.\n\n\nFunctions defined in `bitarray.util` module:\n--------------------------------------------\n\nThis sub-module was added in version 1.2.\n\n``any_and(a, b, /)`` -> bool\n Efficient implementation of ``any(a & b)``.\n\n New in version 2.7\n\n\n``ba2base(n, bitarray, /, group=0, sep=' ')`` -> str\n Return a string containing the base ``n`` ASCII representation of\n the bitarray. Allowed values for ``n`` are 2, 4, 8, 16, 32 and 64.\n The bitarray has to be multiple of length 1, 2, 3, 4, 5 or 6 respectively.\n For ``n=32`` the RFC 4648 Base32 alphabet is used, and for ``n=64`` the\n standard base 64 alphabet is used.\n When grouped, the string ``sep`` is inserted between groups\n of ``group`` characters, default is a space.\n\n See also: `Bitarray representations `__\n\n New in version 1.9\n\n New in version 3.3: optional ``group`` and ``sep`` arguments\n\n\n``ba2hex(bitarray, /, group=0, sep=' ')`` -> hexstr\n Return a string containing the hexadecimal representation of\n the bitarray (which has to be multiple of 4 in length).\n When grouped, the string ``sep`` is inserted between groups\n of ``group`` characters, default is a space.\n\n New in version 3.3: optional ``group`` and ``sep`` arguments\n\n\n``ba2int(bitarray, /, signed=False)`` -> int\n Convert the given bitarray to an integer.\n The bit-endianness of the bitarray is respected.\n ``signed`` indicates whether two's complement is used to represent the integer.\n\n\n``base2ba(n, asciistr, /, endian=None)`` -> bitarray\n Bitarray of base ``n`` ASCII representation.\n Allowed values for ``n`` are 2, 4, 8, 16, 32 and 64.\n For ``n=32`` the RFC 4648 Base32 alphabet is used, and for ``n=64`` the\n standard base 64 alphabet is used. Whitespace is ignored.\n\n See also: `Bitarray representations `__\n\n New in version 1.9\n\n New in version 3.3: ignore whitespace\n\n\n``byteswap(a, /, n=)``\n Reverse every ``n`` consecutive bytes of ``a`` in-place.\n By default, all bytes are reversed. Note that ``n`` is not limited to 2, 4\n or 8, but can be any positive integer.\n Also, ``a`` may be any object that exposes a writeable buffer.\n Nothing about this function is specific to bitarray objects.\n\n New in version 3.4\n\n\n``canonical_decode(bitarray, count, symbol, /)`` -> iterator\n Decode bitarray using canonical Huffman decoding tables\n where ``count`` is a sequence containing the number of symbols of each length\n and ``symbol`` is a sequence of symbols in canonical order.\n\n See also: `Canonical Huffman Coding `__\n\n New in version 2.5\n\n\n``canonical_huffman(dict, /)`` -> tuple\n Given a frequency map, a dictionary mapping symbols to their frequency,\n calculate the canonical Huffman code. Returns a tuple containing:\n\n 0. the canonical Huffman code as a dict mapping symbols to bitarrays\n 1. a list containing the number of symbols of each code length\n 2. a list of symbols in canonical order\n\n Note: the two lists may be used as input for ``canonical_decode()``.\n\n See also: `Canonical Huffman Coding `__\n\n New in version 2.5\n\n\n``correspond_all(a, b, /)`` -> tuple\n Return tuple with counts of: ~a & ~b, ~a & b, a & ~b, a & b\n\n New in version 3.4\n\n\n``count_and(a, b, /)`` -> int\n Return ``(a & b).count()`` in a memory efficient manner,\n as no intermediate bitarray object gets created.\n\n\n``count_n(a, n, value=1, /)`` -> int\n Return lowest index ``i`` for which ``a[:i].count(value) == n``.\n Raises ``ValueError`` when ``n`` exceeds total count (``a.count(value)``).\n\n New in version 2.3.6: optional value argument\n\n\n``count_or(a, b, /)`` -> int\n Return ``(a | b).count()`` in a memory efficient manner,\n as no intermediate bitarray object gets created.\n\n\n``count_xor(a, b, /)`` -> int\n Return ``(a ^ b).count()`` in a memory efficient manner,\n as no intermediate bitarray object gets created.\n\n This is also known as the Hamming distance.\n\n\n``deserialize(bytes, /)`` -> bitarray\n Return a bitarray given a bytes-like representation such as returned\n by ``serialize()``.\n\n See also: `Bitarray representations `__\n\n New in version 1.8\n\n New in version 2.5.0: allow bytes-like argument\n\n\n``hex2ba(hexstr, /, endian=None)`` -> bitarray\n Bitarray of hexadecimal representation. hexstr may contain any number\n (including odd numbers) of hex digits (upper or lower case).\n Whitespace is ignored.\n\n New in version 3.3: ignore whitespace\n\n\n``huffman_code(dict, /, endian=None)`` -> dict\n Given a frequency map, a dictionary mapping symbols to their frequency,\n calculate the Huffman code, i.e. a dict mapping those symbols to\n bitarrays (with given bit-endianness). Note that the symbols are not limited\n to being strings. Symbols may be any hashable object.\n\n\n``int2ba(int, /, length=None, endian=None, signed=False)`` -> bitarray\n Convert the given integer to a bitarray (with given bit-endianness,\n and no leading (big-endian) / trailing (little-endian) zeros), unless\n the ``length`` of the bitarray is provided. An ``OverflowError`` is raised\n if the integer is not representable with the given number of bits.\n ``signed`` determines whether two's complement is used to represent the integer,\n and requires ``length`` to be provided.\n\n\n``intervals(bitarray, /)`` -> iterator\n Compute all uninterrupted intervals of 1s and 0s, and return an\n iterator over tuples ``(value, start, stop)``. The intervals are guaranteed\n to be in order, and their size is always non-zero (``stop - start > 0``).\n\n New in version 2.7\n\n\n``ones(n, /, endian=None)`` -> bitarray\n Create a bitarray of length ``n``, with all values ``1``, and optional\n bit-endianness (``little`` or ``big``).\n\n New in version 2.9\n\n\n``parity(a, /)`` -> int\n Return parity of bitarray ``a``.\n ``parity(a)`` is equivalent to ``a.count() % 2`` but more efficient.\n\n New in version 1.9\n\n\n``pprint(bitarray, /, stream=None, group=8, indent=4, width=80)``\n Prints the formatted representation of object on ``stream`` (which defaults\n to ``sys.stdout``). By default, elements are grouped in bytes (8 elements),\n and 8 bytes (64 elements) per line.\n Non-bitarray objects are printed by the standard library\n function ``pprint.pprint()``.\n\n New in version 1.8\n\n\n``sc_decode(stream)`` -> bitarray\n Decompress binary stream (an integer iterator, or bytes-like object) of a\n sparse compressed (``sc``) bitarray, and return the decoded bitarray.\n This function consumes only one bitarray and leaves the remaining stream\n untouched. Use ``sc_encode()`` for compressing (encoding).\n\n See also: `Compression of sparse bitarrays `__\n\n New in version 2.7\n\n\n``sc_encode(bitarray, /)`` -> bytes\n Compress a sparse bitarray and return its binary representation.\n This representation is useful for efficiently storing sparse bitarrays.\n Use ``sc_decode()`` for decompressing (decoding).\n\n See also: `Compression of sparse bitarrays `__\n\n New in version 2.7\n\n\n``serialize(bitarray, /)`` -> bytes\n Return a serialized representation of the bitarray, which may be passed to\n ``deserialize()``. It efficiently represents the bitarray object (including\n its bit-endianness) and is guaranteed not to change in future releases.\n\n See also: `Bitarray representations `__\n\n New in version 1.8\n\n\n``strip(bitarray, /, mode='right')`` -> bitarray\n Return a new bitarray with zeros stripped from left, right or both ends.\n Allowed values for mode are the strings: ``left``, ``right``, ``both``\n\n\n``subset(a, b, /)`` -> bool\n Return ``True`` if bitarray ``a`` is a subset of bitarray ``b``.\n ``subset(a, b)`` is equivalent to ``a | b == b`` (and equally ``a & b == a``) but\n more efficient as no intermediate bitarray object is created and the buffer\n iteration is stopped as soon as one mismatch is found.\n\n\n``urandom(length, /, endian=None)`` -> bitarray\n Return a bitarray of ``length`` random bits (uses ``os.urandom``).\n\n New in version 1.7\n\n\n``vl_decode(stream, /, endian=None)`` -> bitarray\n Decode binary stream (an integer iterator, or bytes-like object), and\n return the decoded bitarray. This function consumes only one bitarray and\n leaves the remaining stream untouched. Use ``vl_encode()`` for encoding.\n\n See also: `Variable length bitarray format `__\n\n New in version 2.2\n\n\n``vl_encode(bitarray, /)`` -> bytes\n Return variable length binary representation of bitarray.\n This representation is useful for efficiently storing small bitarray\n in a binary stream. Use ``vl_decode()`` for decoding.\n\n See also: `Variable length bitarray format `__\n\n New in version 2.2\n\n\n``xor_indices(a, /)`` -> int\n Return xor reduced indices of all active bits in bitarray ``a``.\n This is essentially equivalent to\n ``reduce(operator.xor, [i for i, v in enumerate(a) if v])``.\n\n New in version 3.2\n\n\n``zeros(n, /, endian=None)`` -> bitarray\n Create a bitarray of length ``n``, with all values ``0``, and optional\n bit-endianness (``little`` or ``big``).\n\n\n","description_content_type":null,"docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["Author","Author-Email","Classifier","Description","Home-Page","License","License-File","Summary"],"home_page":"https://github.com/ilanschnell/bitarray","keywords":null,"license":"PSF-2.0","license_expression":null,"license_files":["LICENSE"],"maintainer":null,"maintainer_email":null,"name":"bitarray","package_url":"https://pypi.org/project/bitarray/","platform":null,"project_url":"https://pypi.org/project/bitarray/","project_urls":{"Homepage":"https://github.com/ilanschnell/bitarray"},"provides_extra":null,"release_url":"https://pypi.org/project/bitarray/3.4.2/","requires_dist":null,"requires_python":null,"summary":"efficient arrays of booleans -- C extension","version":"3.4.2","yanked":false,"yanked_reason":null}

Package search

bitarray

project_urls

Dependencies

All package metadata

Releases