bit-long-vec 0.2.1

//! Vector with fixed bit sized values stored in long.
//!
//! Effective to reduce the amount of memory needed for storage values
//! whose size is not a power of 2. As drawback to set and  get values
//! uses additional CPU cycles for bit operations.
//!
//! # Example
//!
//! In this particular scenario, we want to store 10 bit values. It takes
//! 200 bytes to store 100 values using short. To store 100 values using
//! a bit long vector, 15 lengths are required, which is 120 bytes (-40%).
//!
//! ```
//! use bit_long_vec::BitLongVec;
//!
//! let mut vec = BitLongVec::with_fixed_capacity(100, 10);
//!
//! for index in 0..100 {
//!     vec.set(index, 1023);
//!     assert_eq!(vec.get(index), 1023);
//! }
//! ```
pub struct BitLongVec {
    /// Capacity of array.
    pub capacity: usize,
    /// Bits per value in internal storage.
    pub bits_per_value: u8,
    /// Maximum possible stored value.
    pub max_possible_value: u64,
    /// Internal storage for values.
    pub data: Vec<u64>,
}

impl BitLongVec {
    /// Create a fixed capacity vector. All values are will be initialized to 0.
    ///
    /// # Panics
    ///
    /// Panics if `bits_per_value` is greater or equals 64.
    pub fn with_fixed_capacity(capacity: usize, bits_per_value: u8) -> Self {
        assert!(64 > bits_per_value, "Bit per value must be less than 64");

        let longs_required = ((capacity * bits_per_value as usize) as f64 / 64.0).ceil() as usize;
        let max_possible_value = (1 << bits_per_value as u64) - 1;
        let data = vec![0u64; longs_required]; // <- Fastest way to initialize a vector.

        BitLongVec {
            capacity,
            bits_per_value,
            max_possible_value,
            data,
        }
    }

    /// Create vector from long array.
    ///
    /// # Panics
    ///
    /// Panics if `bits_per_value` >= 64 or data length not match capacity.
    pub fn from_data(data: Vec<u64>, capacity: usize, bits_per_value: u8) -> Self {
        assert!(64 > bits_per_value, "Bit per value must be less than 64");
        let longs_required = ((capacity * bits_per_value as usize) as f64 / 64.0).ceil() as usize;
        assert_eq!(longs_required, data.len(), "Data length not match capacity");

        let max_possible_value = (1 << bits_per_value as u64) - 1;

        BitLongVec {
            capacity,
            bits_per_value,
            max_possible_value,
            data,
        }
    }

    /// Sets the `value` in the` index` position.
    ///
    /// # Panics
    ///
    /// Panics if `index` out of bounds or `value` exceeds maximum.
    pub fn set(&mut self, index: usize, value: u64) {
        assert!(self.capacity > index, "Index out of bounds");
        assert!(self.max_possible_value >= value, "Value exceeds maximum");

        let bit_index = index * self.bits_per_value as usize;
        let long_index = bit_index / 64;
        let long_bit_start_index = bit_index % 64;

        self.data[long_index] &= !(self.max_possible_value << long_bit_start_index as u64);
        self.data[long_index] |= value << long_bit_start_index as u64;

        // Value overlaps in the next long.
        if long_bit_start_index + self.bits_per_value as usize > 64 {
            let bits_written = 64 - long_bit_start_index;
            let bits_remaining = self.bits_per_value as usize - bits_written;

            let remainder_max_possible_value = (1 << bits_remaining as u64) - 1;

            self.data[long_index + 1] &= !(remainder_max_possible_value);
            self.data[long_index + 1] |= value >> bits_written as u64;
        }
    }

    /// Returns the `value` in the` index` position.
    ///
    /// # Panics
    ///
    /// Panics if `index` out of bounds.
    pub fn get(&self, index: usize) -> u64 {
        assert!(self.capacity > index, "Index out of bounds");

        let bit_index = index * self.bits_per_value as usize;
        let long_index = bit_index / 64;
        let long_bit_start_index = bit_index % 64;

        let mut value = self.data[long_index] >> long_bit_start_index as u64;

        // Value overlaps in the next long.
        if long_bit_start_index + self.bits_per_value as usize > 64 {
            value |= self.data[long_index + 1] << 64 - long_bit_start_index as u64;
        }

        value & self.max_possible_value
    }

    /// Return new vector resized to new `bits_per_block`.
    ///
    /// # Panics
    ///
    /// Panics if `bits_per_value` >= 64 or `value` after resize exceeds maximum.
    pub fn resize(&self, bits_per_block: u8) -> BitLongVec {
        let mut new_vec = BitLongVec::with_fixed_capacity(self.capacity, bits_per_block);

        for index in 0..self.capacity {
            new_vec.set(index, self.get(index));
        }

        new_vec
    }
}

#[test]
fn test_longs_required() {
    let data = vec![
        (2048, 4, 128),
        (4096, 4, 256),
        (2048, 8, 256),
        (4096, 8, 512),
        (4096, 14, 896),
    ];

    for (capacity, bits_per_value, expected_length) in data {
        let vec = BitLongVec::with_fixed_capacity(capacity, bits_per_value);

        assert_eq!(vec.data.len(), expected_length);
        assert_eq!(vec.data.capacity(), expected_length);
    }
}

#[test]
fn test_max_possible_value() {
    let data = vec![(4, 15), (5, 31), (6, 63), (7, 127), (8, 255), (14, 16_383)];

    for (bits_per_value, expected_max_possible_value) in data {
        let vec = BitLongVec::with_fixed_capacity(1, bits_per_value);
        assert_eq!(vec.max_possible_value, expected_max_possible_value);
    }
}

#[test]
fn test_set() {
    let mut vec = BitLongVec::with_fixed_capacity(48, 4);

    // long 1: [1, 2, 3, 4, 0, 0, 0, 0]
    // long 2: [5, 6, 7, 8, 0, 0, 0, 0]
    // long 3: [9, 10, 11, 12, 0, 0, 0, 0]
    for long_index in 0..3 {
        for long_byte_index in 0..4 {
            let index = long_index * 16 + long_byte_index;
            let value = (long_index * 4 + long_byte_index + 1) as u64;

            vec.set(index, value);
        }
    }

    assert_eq!(vec.data, vec![17185, 34661, 52137]);
}

#[test]
fn test_set_overlap() {
    let mut vec = BitLongVec::with_fixed_capacity(9, 14);

    for index in 0..9 {
        vec.set(index, (15_000 + index) as u64);
    }

    assert_eq!(vec.data, vec![11306972589037353624, 4224634284506261370]);
}

#[test]
fn test_set_clean_bits() {
    let mut vec = BitLongVec::from_data(vec![2762], 3, 4);
    vec.set(1, 0);

    assert_eq!(vec.data[0], 2570)
}

#[test]
fn test_set_overlap_clean_bits() {
    let data = vec![11306972589037353624, 4224634284506261370];
    let mut vec = BitLongVec::from_data(data, 9, 14);
    vec.set(4, 0);

    assert_eq!(vec.data[0], 65987919120595608);
    assert_eq!(vec.data[1], 4224634284506261312);
}

#[test]
fn test_set_change_bits() {
    let mut vec = BitLongVec::from_data(vec![2762], 3, 4);
    vec.set(1, 8);

    assert_eq!(vec.data[0], 2698);
}

#[test]
fn test_set_overlap_change_bits() {
    let data = vec![11306972589037353624, 4224634284506261370];
    let mut vec = BitLongVec::from_data(data, 9, 14);
    vec.set(4, 8);

    assert_eq!(vec.data[0], 642448671424019096);
    assert_eq!(vec.data[1], 4224634284506261312);
}

#[test]
fn test_get() {
    let data = vec![17185, 34661, 52137];
    let vec = BitLongVec::from_data(data, 48, 4);

    // long 1: [1, 2, 3, 4, 0, 0, 0, 0]
    // long 2: [5, 6, 7, 8, 0, 0, 0, 0]
    // long 3: [9, 10, 11, 12, 0, 0, 0, 0]
    for long_index in 0..3 {
        for long_byte_index in 0..4 {
            let index = long_index * 16 + long_byte_index;
            let value = (long_index * 4 + long_byte_index + 1) as u64;

            assert_eq!(vec.get(index), value)
        }
    }
}

#[test]
fn test_get_overlap() {
    let data = vec![11306972589037353624, 4224634284506261370];
    let vec = BitLongVec::from_data(data, 9, 14);

    for index in 0..9 {
        assert_eq!(vec.get(index), 15_000 + index as u64);
    }
}

#[test]
#[should_panic(expected = "Bit per value must be less than 64")]
fn test_with_fixed_capacity_bits_above_64() {
    BitLongVec::with_fixed_capacity(1, 128);
}

#[test]
#[should_panic(expected = "Bit per value must be less than 64")]
fn test_from_data_bits_above_64() {
    BitLongVec::from_data(vec![], 1, 128);
}

#[test]
#[should_panic(expected = "Data length not match capacity")]
fn test_from_data_length_not_match_capacity() {
    BitLongVec::from_data(vec![1], 3, 32);
}

#[test]
#[should_panic(expected = "Index out of bounds")]
fn test_set_index_out_of_bounds() {
    let mut vec = BitLongVec::with_fixed_capacity(1, 4);
    vec.set(100, 1);
}

#[test]
#[should_panic(expected = "Value exceeds maximum")]
fn test_set_value_exceeds_maximum() {
    let mut vec = BitLongVec::with_fixed_capacity(1, 4);
    vec.set(0, 16);
}

#[test]
#[should_panic(expected = "Index out of bounds")]
fn test_get_index_out_of_bounds() {
    let vec = BitLongVec::with_fixed_capacity(1, 4);
    vec.get(100);
}

#[test]
fn test_resize() {
    let mut vec = BitLongVec::with_fixed_capacity(15, 8);

    for index in 0..15 {
        vec.set(index, index as u64 + 1);
    }

    let new_vec = vec.resize(4);

    for index in 0..15 {
        assert_eq!(vec.get(index), index as u64 + 1);
    }
}