BitVecForeachInRange

Documentation

API Reference

Description

Iterate over bits in a specific range of the given bitvector bv. This is a convenience macro that iterates over a range using an internally managed index. The variable var is declared and defined by this macro.

Parameters

Name	Direction	Description
`bv`	in,out	Bitvector to iterate over.
`var`	in	Name of variable to be used which’ll contain bit value of the current bit.
`start`	in	Starting index (inclusive).
`end`	in	Ending index (exclusive).

Success

Loop body runs once for each bit in [start, end) that lies within bv->length.

Failure

Loop body never executes when the range is empty, inverted, or out of bounds; validator aborts on corrupted magic.

Usage example (Cross-references)

Usage examples (Cross-references)

In BitVec.Foreach.Simple.c:220:

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

In BitVec.Foreach.Simple.c:235:

        u64 false_count = 0;
    
        BitVecForeachInRange(&bv, bit, 1, 3) {
            // Should iterate over indices 1, 2
            // Values: true, true

In BitVec.Foreach.Simple.c:397:

        // Test range with start == end (should not execute)
        int count = 0;
        BitVecForeachInRange(&bv, bit, 5, 5) {
            (void)bit;
            count++; // Should not execute

In BitVec.Foreach.Simple.c:405:

        // Test range with single element
        count = 0;
        BitVecForeachInRange(&bv, bit, 3, 4) {
            count++;
            result = result && (bit == false); // 3 % 2 != 0

In BitVec.Foreach.Simple.c:413:

        // Test range at boundaries
        count = 0;
        BitVecForeachInRange(&bv, bit, 0, 2) {
            (void)bit;
            count++;

In BitVec.Foreach.Simple.c:421:

        // Test range at the end of bitvector
        count = 0;
        BitVecForeachInRange(&bv, bit, 8, 10) {
            (void)bit;
            count++;

In BitVec.Foreach.c:219:

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

In BitVec.Foreach.c:234:

        u64 false_count = 0;
    
        BitVecForeachInRange(&bv, bit, 1, 3) {
            // Should iterate over indices 1, 2
            // Values: true, true

In BitVec.Foreach.c:396:

        // Test range with start == end (should not execute)
        int count = 0;
        BitVecForeachInRange(&bv, bit, 5, 5) {
            (void)bit;
            count++; // Should not execute

In BitVec.Foreach.c:404:

        // Test range with single element
        count = 0;
        BitVecForeachInRange(&bv, bit, 3, 4) {
            count++;
            result = result && (bit == false); // 3 % 2 != 0

In BitVec.Foreach.c:412:

        // Test range at boundaries
        count = 0;
        BitVecForeachInRange(&bv, bit, 0, 2) {
            (void)bit;
            count++;

In BitVec.Foreach.c:420:

        // Test range at the end of bitvector
        count = 0;
        BitVecForeachInRange(&bv, bit, 8, 10) {
            (void)bit;
            count++;

Last updated on June 4, 2026

BitVecForeachIdx BitVecForeachInRangeIdx