BloombergLP::bdlb::BitStringUtil::bits

Return a range of bits from bitString as an integer.

Synopsis

Declared in <bdlb_bitstringutil.h>

static
uint64_t
bits(
    uint64_t const* bitString,
    std::size_t index,
    std::size_t numBits);

Description

Return the specified numBits beginning at the specified index in the specified bitString as the low-order bits of the returned value. The behavior is undefined unless numBits <= k_BITS_PER_UINT64 and bitString has a length of at least index + numBits.

Return Value

the selected bits as the low-order bits of the result

Parameters

NameDescription
bitStringbit string to read
indexstarting bit position
numBitsnumber of bits to return