Struct sdsl::int_vectors::IntVector

pub struct IntVector<const WIDTH: u8> { /* fields omitted */ }

A generic vector for integers of width $ [1..64] $ bits.

This generic vector class can be used to generate a vector that contains integers of fixed width $ [1..64] $.

Arguments

• WIDTH - Width of an integer. If set to 0 it is variable during runtime, otherwise fixed at compile time.

Example

let mut iv = sdsl::int_vectors::IntVector::<0>::new(5, 42, Some(64))?;
iv.bit_resize(2 * iv.width() as usize);

let result: Vec<_> = iv.iter().collect();
let expected = vec![42, 42];
assert_eq!(result, expected);

For further examples see here.

Implementations

impl<const WIDTH: u8> IntVector<WIDTH>

pub fn new(size: usize, default_value: usize, width: Option<u8>) -> Result<Self>

Construct a new integer vector.

Arguments

• size - Number of elements.
• default_value - Default values for elements initialization.
• width - The width of each integer. Must be specified if WIDTH == 0.

pub fn from_file(path: &PathBuf) -> Result<Self>

Load vector from file.

Arguments

• path - File path.

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

Get the i-th element of the vector.

Arguments

• index - An index in range $ [0, \mathrm{len}()) $.

pub fn set(&mut self, index: usize, value: usize)

Set the i-th element of the vector.

Arguments

• index - An index in range $ [0, \mathrm{len}()) $.
• value - New element value.

pub fn is_empty(&self) -> bool

Returns true if the vector is empty, otherwise returns false.

pub fn resize(&mut self, size: usize)

Resize the vector in terms of elements.

Arguments

• size - Target number of elements.

pub fn bit_resize(&mut self, size: usize)

Resize the total vector in terms of bits.

Arguments

• size - The size to resize the vector in terms of bits.

pub fn len(&self) -> usize

The number of elements in the vector.

pub fn max_size(&self) -> usize

Maximum size of the vector.

pub fn bit_size(&self) -> usize

The number of bits in the vector.

pub fn capacity(&self) -> usize

Returns the size of the occupied bits of the vector.

The capacity of a vector is greater or equal to the bit_size().

pub fn data(&self) -> *const c_void

Constant pointer to the raw data of the vector.

pub fn width(&self) -> u8

Returns the width of the integers which are accessed via the get(...) method.

pub fn set_width(&mut self, width: usize) -> Result<()>

Sets the width of the integers which are accessed via the get(...) method, if WIDTH equals 0.

This function does not bit resize each element in the vector. Rather, after using this function, the raw data of the vector will be interpreted differently.

Arguments

• width - New width of the integers.

pub fn iter(&self) -> VectorIterator<'_, Self>

Returns an iterator over the vector values.

Trait Implementations

impl<const WIDTH: u8> Clone for IntVector<WIDTH>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const WIDTH: u8> Debug for IntVector<WIDTH>

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

Formats the value using the given formatter.

impl<const WIDTH: u8> Drop for IntVector<WIDTH>

fn drop(&mut self)

Executes the destructor for this type.

impl<const WIDTH: u8> IntoIterator for IntVector<WIDTH>

type Item = usize

The type of the elements being iterated over.

type IntoIter = VectorIntoIterator<IntVector<WIDTH>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.