BitVecRotateLeft

Documentation

API Reference

BitVecRotateLeft

Description

Rotate all bits in bitvector to the left by specified positions. Bits that fall off the high end wrap around to the low end.

Parameters

Name	Direction	Description
`bv`	in,out	Bitvector to rotate in place.
`positions`	in	Number of positions to rotate left. Effective rotation is `positions % length`.

Usage example (from documentation)

  BitVecRotateLeft(&flags, 5);

Success

Returns to the caller. Each previous bit at index i is now at index (i + positions) % length. No bits are lost; length and capacity are unchanged.

Failure

Function cannot fail. An invalid bitvector is a caller bug and aborts via LOG_FATAL.

Usage example (Cross-references)

Usage examples (Cross-references)

In BitVec.c:1108:

    }
    
    void BitVecRotateLeft(BitVec *bv, u64 positions) {
        ValidateBitVec(bv);
        if (positions == 0 || bv->length == 0) {

In BitVec.BitWise.Simple.c:278:

        DefaultAllocator alloc = DefaultAllocatorInit();
    
        WriteFmt("Testing BitVecRotateLeft\n");
    
        BitVec bv = BitVecInit(ALLOCATOR_OF(&alloc));

In BitVec.BitWise.Simple.c:289:

    
        // Rotate left by 2 positions
        BitVecRotateLeft(&bv, 2);
    
        // Expected result: 1110 (1011 rotated left by 2)

In BitVec.BitWise.Simple.c:419:

    
        // Test rotate empty bitvec
        BitVecRotateLeft(&bv, 5);
        result = result && (BitVecLen(&bv) == 0);

In BitVec.BitWise.Simple.c:429:

        // Test rotate by length (should be no-op)
        BitVecPush(&bv, false);
        BitVecRotateLeft(&bv, 2);
        result = result && (BitVecLen(&bv) == 2);

In BitVec.BitWise.Simple.c:675:

    
        // Rotate left by 3, then right by 3
        BitVecRotateLeft(&bv, 3);
        BitVecRotateRight(&bv, 3);

In BitVec.BitWise.Simple.c:689:

    
        // Test rotate by multiple of length (should be no-op)
        BitVecRotateLeft(&bv, 16); // 8 * 2
    
        bool unchanged = true;

In BitVec.BitWise.Simple.c:708:

        BitVecPush(&bv, true); // 5 bits: 10101
    
        BitVecRotateLeft(&bv, 2);
        // 10101 -> 10110 (rotated left by 2)
        result = result && (BitVecGet(&bv, 0) == true);

In BitVec.BitWise.Deadend.c:71:

    
        // Test NULL pointer for rotate - should abort
        BitVecRotateLeft(NULL, 3);
    
        return false;

In BitVec.BitWise.c:278:

        DefaultAllocator alloc = DefaultAllocatorInit();
    
        WriteFmtLn("Testing BitVecRotateLeft");
    
        BitVec bv = BitVecInit(ALLOCATOR_OF(&alloc));

In BitVec.BitWise.c:289:

    
        // Rotate left by 2 positions
        BitVecRotateLeft(&bv, 2);
    
        // Expected result: 1110 (1011 rotated left by 2)

In BitVec.BitWise.c:419:

    
        // Test rotate empty bitvec
        BitVecRotateLeft(&bv, 5);
        result = result && (BitVecLen(&bv) == 0);

In BitVec.BitWise.c:429:

        // Test rotate by length (should be no-op)
        BitVecPush(&bv, false);
        BitVecRotateLeft(&bv, 2);
        result = result && (BitVecLen(&bv) == 2);

In BitVec.BitWise.c:675:

    
        // Rotate left by 3, then right by 3
        BitVecRotateLeft(&bv, 3);
        BitVecRotateRight(&bv, 3);

In BitVec.BitWise.c:689:

    
        // Test rotate by multiple of length (should be no-op)
        BitVecRotateLeft(&bv, 16); // 8 * 2
    
        bool unchanged = true;

In BitVec.BitWise.c:708:

        BitVecPush(&bv, true); // 5 bits: 10101
    
        BitVecRotateLeft(&bv, 2);
        // 10101 -> 10110 (rotated left by 2)
        result = result && (BitVecGet(&bv, 0) == true);

In BitVec.BitWise.c:998:

    
        // Test NULL pointer for rotate - should abort
        BitVecRotateLeft(NULL, 3);
    
        return false;

Last updated on June 4, 2026

BitVecRFindPattern BitVecRotateRight