Skip to main content

BitPackedInts

Struct BitPackedInts 

Source
pub struct BitPackedInts { /* private fields */ }
Expand description

Bit-packed integer array.

Stores integers using a fixed number of bits per value, determined by the maximum value in the array.

Implementations§

Source§

impl BitPackedInts

Source

pub fn pack(values: &[u64]) -> Self

Packs a slice of u64 values using the minimum bits needed.

Source

pub fn pack_with_bits(values: &[u64], bits_per_value: u8) -> Self

Packs values using a specified bit width.

§Panics

Panics if any value doesn’t fit in the specified bit width.

Source

pub fn unpack(&self) -> Vec<u64>

Unpacks all values back to u64.

Source

pub fn get(&self, index: usize) -> Option<u64>

Gets a single value at the given index.

Source

pub fn len(&self) -> usize

Returns the number of values.

Source

pub fn is_empty(&self) -> bool

Returns whether the encoding is empty.

Source

pub fn bits_per_value(&self) -> u8

Returns the number of bits per value.

Source

pub fn data(&self) -> &[u64]

Returns the raw packed data.

Source

pub fn compression_ratio(&self) -> f64

Returns the compression ratio compared to storing full u64s.

Source

pub fn bits_needed(value: u64) -> u8

Returns the number of bits needed to represent a value.

Source

pub fn to_bytes(&self) -> Vec<u8>

Serializes to bytes.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Deserializes from bytes.

Trait Implementations§

Source§

impl Clone for BitPackedInts

Source§

fn clone(&self) -> BitPackedInts

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BitPackedInts

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.