Skip to main content

Module std::bit_vector

Module Functions​

pub new​

public fun new(length: u64): std::bit_vector::BitVector
Implementation
public fun new(length: u64): BitVector {
    assert!(length > 0, ELENGTH);
    assert!(length < MAX_SIZE, ELENGTH);
    let mut counter = 0;
    let mut bit_field = vector::empty();
    while (counter < length) {
        bit_field.push_back(false);
        counter = counter + 1;
    };
    BitVector {
        length,
        bit_field,
    }
}

Structs​

struct BitVector​

public struct BitVector has copy, drop, store
Fields
length: u64
bit_field: vector<bool>

pub is_index_set​

Return the value of the bit at bit_index in the bitvector. true represents "1" and false represents a 0

public fun is_index_set(bitvector: &std::bit_vector::BitVector, bit_index: u64): bool
Implementation
public fun is_index_set(bitvector: &BitVector, bit_index: u64): bool {
    assert!(bit_index < bitvector.bit_field.length(), EINDEX);
    bitvector.bit_field[bit_index]
}

pub length​

Return the length (number of usable bits) of this bitvector

public fun length(bitvector: &std::bit_vector::BitVector): u64
Implementation
public fun length(bitvector: &BitVector): u64 {
    bitvector.bit_field.length()
}

pub longest_set_sequence_starting_at​

Returns the length of the longest sequence of set bits starting at (and including) start_index in the bitvector. If there is no such sequence, then 0 is returned.

public fun longest_set_sequence_starting_at(bitvector: &std::bit_vector::BitVector, start_index: u64): u64
Implementation
public fun longest_set_sequence_starting_at(bitvector: &BitVector, start_index: u64): u64 {
    assert!(start_index < bitvector.length, EINDEX);
    let mut index = start_index;
    // Find the greatest index in the vector such that all indices less than it are set.
    while (index < bitvector.length) {
        if (!bitvector.is_index_set(index)) break;
        index = index + 1;
    };
    index - start_index
}

pub set​

Set the bit at bit_index in the bitvector regardless of its previous state.

public fun set(bitvector: &mut std::bit_vector::BitVector, bit_index: u64)
Implementation
public fun set(bitvector: &mut BitVector, bit_index: u64) {
    assert!(bit_index < bitvector.bit_field.length(), EINDEX);
    let x = &mut bitvector.bit_field[bit_index];
    *x = true;
}

pub shift_left​

Shift the bitvector left by amount. If amount is greater than the bitvector's length the bitvector will be zeroed out.

public fun shift_left(bitvector: &mut std::bit_vector::BitVector, amount: u64)
Implementation
public fun shift_left(bitvector: &mut BitVector, amount: u64) {
    if (amount >= bitvector.length) {
        let len = bitvector.bit_field.length();
        let mut i = 0;
        while (i < len) {
            let elem = &mut bitvector.bit_field[i];
            *elem = false;
            i = i + 1;
        };
    } else {
        let mut i = amount;
        while (i < bitvector.length) {
            if (bitvector.is_index_set(i)) bitvector.set(i - amount)
            else bitvector.unset(i - amount);
            i = i + 1;
        };
        i = bitvector.length - amount;
        while (i < bitvector.length) {
            unset(bitvector, i);
            i = i + 1;
        };
    }
}

pub unset​

Unset the bit at bit_index in the bitvector regardless of its previous state.

public fun unset(bitvector: &mut std::bit_vector::BitVector, bit_index: u64)
Implementation
public fun unset(bitvector: &mut BitVector, bit_index: u64) {
    assert!(bit_index < bitvector.bit_field.length(), EINDEX);
    let x = &mut bitvector.bit_field[bit_index];
    *x = false;
}

Constants​

err EINDEX​

The provided index is out of bounds

const EINDEX: u64 = 131072;

err ELENGTH​

An invalid length of bitvector was given

const ELENGTH: u64 = 131073;

const WORD_SIZE​

const WORD_SIZE: u64 = 1;

const MAX_SIZE​

The maximum allowed bitvector size

const MAX_SIZE: u64 = 1024;