:mod:`bitops`
=============

.. py:module:: bitops

.. autoapi-nested-parse::

   Routines for low-level manipulation of binary data



.. raw:: html

    <p>
    <details>
    <summary>Available on these boards</summary>
    <ul>
    <li> Adafruit Feather RP2040
    <li> Adafruit ItsyBitsy RP2040
    <li> Adafruit KB2040
    <li> Adafruit Macropad RP2040
    <li> Adafruit QT Py RP2040
    <li> Adafruit QT2040 Trinkey
    <li> Arduino Nano RP2040 Connect
    <li> Challenger NB RP2040 WiFi
    <li> Challenger RP2040 LTE
    <li> Challenger RP2040 WiFi
    <li> Cytron Maker Nano RP2040
    <li> Cytron Maker Pi RP2040
    <li> EncoderPad RP2040
    <li> Melopero Shake RP2040
    <li> Oak Dev Tech BREAD2040
    <li> Pimoroni Interstate 75
    <li> Pimoroni Keybow 2040
    <li> Pimoroni PGA2040
    <li> Pimoroni Pico LiPo (16MB)
    <li> Pimoroni Pico LiPo (4MB)
    <li> Pimoroni PicoSystem
    <li> Pimoroni Plasma 2040
    <li> Pimoroni Tiny 2040
    <li> PyKey60
    <li> RP2040 Stamp
    <li> Raspberry Pi Pico
    <li> SparkFun MicroMod RP2040 Processor
    <li> SparkFun Pro Micro RP2040
    <li> SparkFun Thing Plus - RP2040
    </ul>
    </details>
    </p>




.. py:function:: bit_transpose(input: _typing.ReadableBuffer, output: _typing.WriteableBuffer, width: int = 8) -> _typing.WriteableBuffer

   "Transpose" a buffer by assembling each output byte with bits taken from each of ``width`` different input bytes.

   This can be useful to convert a sequence of pixel values into a single
   stream of bytes suitable for sending via a parallel conversion method.

   The number of bytes in the input buffer must be a multiple of the width,
   and the width can be any value from 2 to 8.  If the width is fewer than 8,
   then the remaining (less significant) bits of the output are set to zero.

   Let ``stride = len(input)//width``.  Then the first byte is made out of the
   most significant bits of ``[input[0], input[stride], input[2*stride], ...]``.
   The second byte is made out of the second bits, and so on until the 8th output
   byte which is made of the first bits of ``input[1], input[1+stride,
   input[2*stride], ...]``.

   The required output buffer size is ``len(input) * 8  // width``.

   Returns the output buffer.