Module `std::bit_vector`

Struct BitVector
Constants
Function new
Function set
Function unset
Function shift_left
Function is_index_set
Function length
Function longest_set_sequence_starting_at

Struct `BitVector`

<pre><code>public struct <a href="../std/bit_vector.md#std_bit_vector_BitVector">BitVector</a> has copy, drop, store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code><a href="../std/bit_vector.md#std_bit_vector_length">length</a>: <a href="../std/u64.md#std_u64">u64</a></code> </dt> <dd> </dd> <dt> <code>bit_field: <a href="../std/vector.md#std_vector">vector</a><<a href="../std/bool.md#std_bool">bool</a>></code> </dt> <dd> </dd> </dl> </details>

Constants

The provided index is out of bounds

<pre><code>const <a href="../std/bit_vector.md#std_bit_vector_EINDEX">EINDEX</a>: <a href="../std/u64.md#std_u64">u64</a> = 131072; </code></pre>

An invalid length of bitvector was given

<pre><code>const <a href="../std/bit_vector.md#std_bit_vector_ELENGTH">ELENGTH</a>: <a href="../std/u64.md#std_u64">u64</a> = 131073; </code></pre>

<pre><code>const <a href="../std/bit_vector.md#std_bit_vector_WORD_SIZE">WORD_SIZE</a>: <a href="../std/u64.md#std_u64">u64</a> = 1; </code></pre>

The maximum allowed bitvector size

<pre><code>const <a href="../std/bit_vector.md#std_bit_vector_MAX_SIZE">MAX_SIZE</a>: <a href="../std/u64.md#std_u64">u64</a> = 1024; </code></pre>

Function `new`

<pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_new">new</a>(<a href="../std/bit_vector.md#std_bit_vector_length">length</a>: <a href="../std/u64.md#std_u64">u64</a>): <a href="../std/bit_vector.md#std_bit_vector_BitVector">std::bit_vector::BitVector</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_new">new</a>(<a href="../std/bit_vector.md#std_bit_vector_length">length</a>: <a href="../std/u64.md#std_u64">u64</a>): <a href="../std/bit_vector.md#std_bit_vector_BitVector">BitVector</a> { assert!(<a href="../std/bit_vector.md#std_bit_vector_length">length</a> > 0, <a href="../std/bit_vector.md#std_bit_vector_ELENGTH">ELENGTH</a>); assert!(<a href="../std/bit_vector.md#std_bit_vector_length">length</a> < <a href="../std/bit_vector.md#std_bit_vector_MAX_SIZE">MAX_SIZE</a>, <a href="../std/bit_vector.md#std_bit_vector_ELENGTH">ELENGTH</a>); let mut counter = 0; let mut bit_field = <a href="../std/vector.md#std_vector_empty">vector::empty</a>(); while (counter < <a href="../std/bit_vector.md#std_bit_vector_length">length</a>) { bit_field.push_back(false); counter = counter + 1; }; <a href="../std/bit_vector.md#std_bit_vector_BitVector">BitVector</a> { <a href="../std/bit_vector.md#std_bit_vector_length">length</a>, bit_field, } } </code></pre> </details>

Function `set`

Set the bit at <code>bit_index</code> in the <code>bitvector</code> regardless of its previous state.

<pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_set">set</a>(bitvector: &mut <a href="../std/bit_vector.md#std_bit_vector_BitVector">std::bit_vector::BitVector</a>, bit_index: <a href="../std/u64.md#std_u64">u64</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_set">set</a>(bitvector: &mut <a href="../std/bit_vector.md#std_bit_vector_BitVector">BitVector</a>, bit_index: <a href="../std/u64.md#std_u64">u64</a>) { assert!(bit_index < bitvector.bit_field.<a href="../std/bit_vector.md#std_bit_vector_length">length</a>(), <a href="../std/bit_vector.md#std_bit_vector_EINDEX">EINDEX</a>); let x = &mut bitvector.bit_field[bit_index]; *x = true; } </code></pre> </details>

Function `unset`

Unset the bit at <code>bit_index</code> in the <code>bitvector</code> regardless of its previous state.

<pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_unset">unset</a>(bitvector: &mut <a href="../std/bit_vector.md#std_bit_vector_BitVector">std::bit_vector::BitVector</a>, bit_index: <a href="../std/u64.md#std_u64">u64</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_unset">unset</a>(bitvector: &mut <a href="../std/bit_vector.md#std_bit_vector_BitVector">BitVector</a>, bit_index: <a href="../std/u64.md#std_u64">u64</a>) { assert!(bit_index < bitvector.bit_field.<a href="../std/bit_vector.md#std_bit_vector_length">length</a>(), <a href="../std/bit_vector.md#std_bit_vector_EINDEX">EINDEX</a>); let x = &mut bitvector.bit_field[bit_index]; *x = false; } </code></pre> </details>

Function `shift_left`

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

<pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_shift_left">shift_left</a>(bitvector: &mut <a href="../std/bit_vector.md#std_bit_vector_BitVector">std::bit_vector::BitVector</a>, amount: <a href="../std/u64.md#std_u64">u64</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_shift_left">shift_left</a>(bitvector: &mut <a href="../std/bit_vector.md#std_bit_vector_BitVector">BitVector</a>, amount: <a href="../std/u64.md#std_u64">u64</a>) { if (amount >= bitvector.<a href="../std/bit_vector.md#std_bit_vector_length">length</a>) { let len = bitvector.bit_field.<a href="../std/bit_vector.md#std_bit_vector_length">length</a>(); 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.<a href="../std/bit_vector.md#std_bit_vector_length">length</a>) { if (bitvector.<a href="../std/bit_vector.md#std_bit_vector_is_index_set">is_index_set</a>(i)) bitvector.<a href="../std/bit_vector.md#std_bit_vector_set">set</a>(i - amount) else bitvector.<a href="../std/bit_vector.md#std_bit_vector_unset">unset</a>(i - amount); i = i + 1; }; i = bitvector.<a href="../std/bit_vector.md#std_bit_vector_length">length</a> - amount; while (i < bitvector.<a href="../std/bit_vector.md#std_bit_vector_length">length</a>) { <a href="../std/bit_vector.md#std_bit_vector_unset">unset</a>(bitvector, i); i = i + 1; }; } } </code></pre> </details>

Function `is_index_set`

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

<pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_is_index_set">is_index_set</a>(bitvector: &<a href="../std/bit_vector.md#std_bit_vector_BitVector">std::bit_vector::BitVector</a>, bit_index: <a href="../std/u64.md#std_u64">u64</a>): <a href="../std/bool.md#std_bool">bool</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_is_index_set">is_index_set</a>(bitvector: &<a href="../std/bit_vector.md#std_bit_vector_BitVector">BitVector</a>, bit_index: <a href="../std/u64.md#std_u64">u64</a>): <a href="../std/bool.md#std_bool">bool</a> { assert!(bit_index < bitvector.bit_field.<a href="../std/bit_vector.md#std_bit_vector_length">length</a>(), <a href="../std/bit_vector.md#std_bit_vector_EINDEX">EINDEX</a>); bitvector.bit_field[bit_index] } </code></pre> </details>

Function `length`

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

<pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_length">length</a>(bitvector: &<a href="../std/bit_vector.md#std_bit_vector_BitVector">std::bit_vector::BitVector</a>): <a href="../std/u64.md#std_u64">u64</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_length">length</a>(bitvector: &<a href="../std/bit_vector.md#std_bit_vector_BitVector">BitVector</a>): <a href="../std/u64.md#std_u64">u64</a> { bitvector.bit_field.<a href="../std/bit_vector.md#std_bit_vector_length">length</a>() } </code></pre> </details>

Function `longest_set_sequence_starting_at`

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

<pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_longest_set_sequence_starting_at">longest_set_sequence_starting_at</a>(bitvector: &<a href="../std/bit_vector.md#std_bit_vector_BitVector">std::bit_vector::BitVector</a>, start_index: <a href="../std/u64.md#std_u64">u64</a>): <a href="../std/u64.md#std_u64">u64</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../std/bit_vector.md#std_bit_vector_longest_set_sequence_starting_at">longest_set_sequence_starting_at</a>(bitvector: &<a href="../std/bit_vector.md#std_bit_vector_BitVector">BitVector</a>, start_index: <a href="../std/u64.md#std_u64">u64</a>): <a href="../std/u64.md#std_u64">u64</a> { assert!(start_index < bitvector.<a href="../std/bit_vector.md#std_bit_vector_length">length</a>, <a href="../std/bit_vector.md#std_bit_vector_EINDEX">EINDEX</a>); let mut index = start_index; // Find the greatest index in the <a href="../std/vector.md#std_vector">vector</a> such that all indices less than it are <a href="../std/bit_vector.md#std_bit_vector_set">set</a>. while (index < bitvector.<a href="../std/bit_vector.md#std_bit_vector_length">length</a>) { if (!bitvector.<a href="../std/bit_vector.md#std_bit_vector_is_index_set">is_index_set</a>(index)) break; index = index + 1; }; index - start_index } </code></pre> </details>

Module `std::bit_vector`

Module std::bit_vector

Struct BitVector

Constants

Function new

Function set

Function unset

Function shift_left

Function is_index_set

Function length

Function longest_set_sequence_starting_at

Module `std::bit_vector`

Struct `BitVector`

Function `new`

Function `set`

Function `unset`

Function `shift_left`

Function `is_index_set`

Function `length`

Function `longest_set_sequence_starting_at`