1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

/*!
# grit-bitvec

This crate provides [`BitVec`], a vector that can store data elements of fixed-size bit widths that do not fall into the 8/16/32/64/128
size categories. For example, rather than storing a vector of `bool`s in one byte each, you can store them each as one bit. Another example would be storing unsigned integers that are always in the range 0-3 as exactly 2 bits, 0-7 as 3 bits, or 0-15 as 4 bits, or even -1024 to 1023 as 11 bits.

This allows considerable gains in memory usage for applications where the number of elements may be non-trivial, at the cost of processing cost to access the elements.

The additional processing cost is not terrible in most cases, as it is mostly performed with bitwise shifts and simple arithmetic, and is further reduced by using constant comparisons to reduce many bitwise math functions to their easiest possible form. However they are not free, and the insert() and remove() functions may be even more costly due to the need to run those checks and shifts on every element rather than using `ptr::copy()` like `Vec` does internally

by default the `small_int_impls` feature is enabled, providing an simple [`BitElem`] implementation for `bool` and integer types smaller than 16 bits (for example `u8_as_u3` or `i16_as_i11`), and the `large_int_impls` feature can be activated to get similar implementations for bit widths less than `usize::BITS`

This crate currently has no documentation, and full testing is ongoing, however push(), pop(), remove(), and insert()
should work as intended at the very least

This library is very much in the "unstable" phase and the API may change in the future
*/

pub(crate) use core::{
    mem::{
        self,
        size_of,
        align_of,
        needs_drop,
    },
    ptr::{
        self,
        NonNull,
    },
    marker::PhantomData,
};
pub(crate) use std::alloc::{self, Layout};

mod bitvec;
pub use bitvec::*;
mod bitvec_elem;
pub use bitvec_elem::*;
mod bitvec_iter;
pub use bitvec_iter::*;
mod utils;
pub(crate) use utils::*;

mod bitvec_test;