std::bit_compress

template< class T >
constexpr T bit_compress( T x, T m ) noexcept;

Selects the bits of x where m has a 1-bit, and packs them contiguously to the right. The remaining bits are 0.

This overload participates in overload resolution only if T is an unsigned integer type (that is, unsignedchar, unsignedshort, unsignedint, unsignedlong, unsignedlonglong, or an extended unsigned integer type).

Parameters

Return value

x with the bit-packing through the mask m applied.

Notes

The function is has the same result as the PEXT x86_64 and BEXT ARM instructions.

Possible implementation

template<typename T, typename ... U>
concept neither = (!std::same_as<T, U> && ...);

template<std::unsigned_integral T>
    requires neither<T, bool, char, char8_t, char16_t, char32_t, wchar_t>
constexpr T bit_compress(T x) noexcept
{
    T result = 0;
    for (int i = 0, j = 0; i < std::numeric_limits<T>::digits; ++i)
    {
        bool mask_bit = (m >> i) & 1;
        result |= (mask_bit & (x >> i)) << j;
        j += mask_bit;
    }
    return result;
}

Example

#include <bit>
#include <cstdint>

static_assert(
    std::bit_compress(
        std::uint16_t{0xABCD}, // source
        std::uint16_t{0x0F0F}) // mask
    ==  std::uint16_t{0x00BD}  // result
);
static_assert(
    std::bit_compress(
        std::uint8_t{0b0100'1001}, // source
        std::uint8_t{0b1100'1100}) // mask
    ==  std::uint8_t{0b0000'0110}  // result
);

int main() {}

See also