/D

core.bitop

This module contains a collection of bit-level operations.

Authors:
Don Clugston, Sean Kelly, Walter Bright, Alex Rønne Petersen, Thomas Stuart Bockman
Source
core/bitop.d
pure nothrow @nogc @safe int bsf(uint v)
pure nothrow @nogc @safe int bsf(ulong v)

Scans the bits in `v` starting with bit 0, looking for the first set bit.

Returns:
The bit number of the first bit set. The return value is undefined if `v` is zero.
Examples:
```assert(bsf(0x21) == 0);
assert(bsf(ulong.max << 39) == 39);
```
pure nothrow @nogc @safe int bsr(uint v)
pure nothrow @nogc @safe int bsr(ulong v)

Scans the bits in `v` from the most significant bit to the least significant bit, looking for the first set bit.

Returns:
The bit number of the first bit set. The return value is undefined if `v` is zero.
Examples:
```assert(bsr(0x21) == 5);
assert(bsr((ulong.max >> 15) - 1) == 48);
```
pure nothrow @nogc @system int bt(in size_t* p, size_t bitnum)

Tests the bit. (No longer an intrisic - the compiler recognizes the patterns in the body.)

Examples:
```size_t[2] array;

array[0] = 2;
array[1] = 0x100;

assert(bt(array.ptr, 1));
assert(array[0] == 2);
assert(array[1] == 0x100);
```
pure nothrow @nogc @system int btc(size_t* p, size_t bitnum)

Tests and complements the bit.

pure nothrow @nogc @system int btr(size_t* p, size_t bitnum)

Tests and resets (sets to 0) the bit.

pure nothrow @nogc @system int bts(size_t* p, size_t bitnum)

Tests and sets the bit.

Parameters:
 size_t* `p` a non-NULL pointer to an array of size_ts. size_t `bitnum` a bit number, starting with bit 0 of `p`[0], and progressing. It addresses bits like the expression: ```p[index / (size_t.sizeof*8)] & (1 << (index & ((size_t.sizeof*8) - 1))) ```
Returns:
A non-zero value if the bit was set, and a zero if it was clear.
Examples:
```size_t[2] array;

array[0] = 2;
array[1] = 0x100;

assert(btc(array.ptr, 35) == 0);
if (size_t.sizeof == 8)
{
assert(array[0] == 0x8_0000_0002);
assert(array[1] == 0x100);
}
else
{
assert(array[0] == 2);
assert(array[1] == 0x108);
}

assert(btc(array.ptr, 35));
assert(array[0] == 2);
assert(array[1] == 0x100);

assert(bts(array.ptr, 35) == 0);
if (size_t.sizeof == 8)
{
assert(array[0] == 0x8_0000_0002);
assert(array[1] == 0x100);
}
else
{
assert(array[0] == 2);
assert(array[1] == 0x108);
}

assert(btr(array.ptr, 35));
assert(array[0] == 2);
assert(array[1] == 0x100);
```
struct BitRange

Range over bit set. Each element is the bit number that is set.

This is more efficient than testing each bit in a sparsely populated bit set. Note that the first bit in the bit set would be bit 0.

Examples:
```import core.stdc.stdlib : malloc, free;
import core.stdc.string : memset;

// initialize a bit array
enum nBytes = (100 + BitRange.bitsPerWord - 1) / 8;
size_t *bitArr = cast(size_t *)malloc(nBytes);
scope(exit) free(bitArr);
memset(bitArr, 0, nBytes);

// set some bits
bts(bitArr, 48);
bts(bitArr, 24);
bts(bitArr, 95);
bts(bitArr, 78);

enum sum = 48 + 24 + 95 + 78;

// iterate
size_t testSum;
size_t nBits;
foreach(b; BitRange(bitArr, 100))
{
testSum += b;
++nBits;
}

assert(testSum == sum);
assert(nBits == 4);
```
enum ulong bitsPerWord

Number of bits in each size_t

pure nothrow @nogc @system this(const(size_t)* bitarr, size_t numBits)

Construct a BitRange.

Parameters:
pure nothrow @nogc @safe size_t front()
const pure nothrow @nogc @safe bool empty()
pure nothrow @nogc @system void popFront()

Range functions

pure nothrow @nogc @safe uint bswap(uint v)

Swaps bytes in a 4 byte uint end-to-end, i.e. byte 0 becomes byte 3, byte 1 becomes byte 2, byte 2 becomes byte 1, byte 3 becomes byte 0.

pure nothrow @nogc @safe ulong bswap(ulong v)

Swaps bytes in an 8 byte ulong end-to-end, i.e. byte 0 becomes byte 7, byte 1 becomes byte 6, etc.

nothrow @nogc @system ubyte inp(uint port_address)
nothrow @nogc @system ushort inpw(uint port_address)
nothrow @nogc @system uint inpl(uint port_address)

Reads I/O port at `port_address`.

nothrow @nogc @system ubyte outp(uint port_address, ubyte value)
nothrow @nogc @system ushort outpw(uint port_address, ushort value)
nothrow @nogc @system uint outpl(uint port_address, uint value)

Writes and returns `value` to I/O port at `port_address`.

pure nothrow @nogc @safe int popcnt(uint x)
pure nothrow @nogc @safe int popcnt(ulong x)

Calculates the number of set bits in an integer.

pure nothrow @nogc @safe ushort _popcnt(ushort x)
pure nothrow @nogc @safe int _popcnt(uint x)
pure nothrow @nogc @safe int _popcnt(ulong x)

Calculates the number of set bits in an integer using the X86 SSE4 POPCNT instruction. POPCNT is not available on all X86 CPUs.

nothrow @nogc @safe ubyte volatileLoad(ubyte* ptr)
nothrow @nogc @safe ushort volatileLoad(ushort* ptr)
nothrow @nogc @safe uint volatileLoad(uint* ptr)
nothrow @nogc @safe ulong volatileLoad(ulong* ptr)
nothrow @nogc @safe void volatileStore(ubyte* ptr, ubyte value)
nothrow @nogc @safe void volatileStore(ushort* ptr, ushort value)
nothrow @nogc @safe void volatileStore(uint* ptr, uint value)
nothrow @nogc @safe void volatileStore(ulong* ptr, ulong value)

Read/write `value` from/to the memory location indicated by `ptr`.

These functions are recognized by the compiler, and calls to them are guaranteed to not be removed (as dead assignment elimination or presumed to have no effect) or reordered in the same thread.

These reordering guarantees are only made with regards to other operations done through these functions; the compiler is free to reorder regular loads/stores with regards to loads/stores done through these functions.

This is useful when dealing with memory-mapped I/O (MMIO) where a store can have an effect other than just writing a `value`, or where sequential loads with no intervening stores can retrieve different values from the same location due to external stores to the location.

These functions will, when possible, do the load/store as a single operation. In general, this is possible when the size of the operation is less than or equal to `(void*).sizeof`, although some targets may support larger operations. If the load/store cannot be done as a single operation, multiple smaller operations will be used.

These are not to be conflated with atomic operations. They do not guarantee any atomicity. This may be provided by coincidence as a result of the instructions used on the target, but this should not be relied on for portable programs. Further, no memory fences are implied by these functions. They should not be used for communication between threads. They may be used to guarantee a write or read cycle occurs at a specified address.

pure nothrow @nogc @safe uint bitswap(uint x)

Reverses the order of bits in a 32-bit integer.

pure nothrow @nogc @safe ulong bitswap(ulong x)

Reverses the order of bits in a 64-bit integer.

pure T rol(T)(in T value, in uint count)
pure T ror(T)(in T value, in uint count)
pure T rol(uint count, T)(in T value)
pure T ror(uint count, T)(in T value)

Constraints:
if (__traits(isIntegral, T) && __traits(isUnsigned, T))
if (__traits(isIntegral, T) && __traits(isUnsigned, T))
if (__traits(isIntegral, T) && __traits(isUnsigned, T))
if (__traits(isIntegral, T) && __traits(isUnsigned, T))

Bitwise rotate `value` left (`rol`) or right (`ror`) by `count` bit positions.

Examples:
```ubyte a = 0b10101010U;
ulong b = ulong.max;

assert(rol(a, 1) == 0b01010101);
assert(ror(a, 1) == 0b01010101);
assert(rol(a, 3) == 0b01010101);
assert(ror(a, 3) == 0b01010101);

assert(rol(a, 0) == a);
assert(ror(a, 0) == a);

assert(rol(b, 63) == ulong.max);
assert(ror(b, 63) == ulong.max);

assert(rol!3(a) == 0b01010101);
assert(ror!3(a) == 0b01010101);
```

© 1999–2017 The D Language Foundation