Struct IntVector 

pub struct IntVector { /* private fields */ }

A contiguous growable and mutable bit-packed array of fixed-width integers.

This structure contains RawVector, which is in turn contains Vec. Each item consists of the lowest 1 to 64 bits of a u64 value, as specified by parameter width. The maximum length of the vector is usize::MAX / width items.

A default constructed IntVector has width == 64. IntVector can be built from an iterator over u8, u16, u32, u64, or usize values.

IntVector implements the following simple_sds traits:

• Basic functionality: Vector, Resize, Pack
• Queries and operations: Access, Push, Pop
• Serialization: Serialize

Notes

• IntVector never panics from I/O errors.

Implementations

impl IntVector

pub fn new(width: usize) -> Result<IntVector, &'static str>

Creates an empty vector with specified width.

Returns Err if the width is invalid.

Examples

use simple_sds_sbwt::int_vector::IntVector;
use simple_sds_sbwt::ops::Vector;

let v = IntVector::new(13).unwrap();
assert!(v.is_empty());
assert_eq!(v.width(), 13);

pub fn with_len( len: usize, width: usize, value: u64, ) -> Result<IntVector, &'static str>

Creates an initialized vector of specified length and width.

Returns Err if the width is invalid.

Arguments

• len: Number of items in the vector.
• width: Width of each item in bits.
• value: Initialization value.

Examples

use simple_sds_sbwt::int_vector::IntVector;
use simple_sds_sbwt::ops::{Vector, Access};

let v = IntVector::with_len(4, 13, 1234).unwrap();
assert_eq!(v.len(), 4);
assert_eq!(v.width(), 13);
for i in 0..v.len() {
    assert_eq!(v.get(i), 1234);
}

Panics

May panic if the vector would exceed the maximum length.

pub fn with_capacity( capacity: usize, width: usize, ) -> Result<IntVector, &'static str>

Creates an empty vector with enough capacity for at least the specified number of items of specified width.

Returns Err if the width is invalid.

Arguments

• capacity: Minimum capacity of the vector in items.
• width: Width of each item in bits.

Examples

use simple_sds_sbwt::int_vector::IntVector;
use simple_sds_sbwt::ops::{Vector, Resize};

let v = IntVector::with_capacity(4, 13).unwrap();
assert!(v.is_empty());
assert_eq!(v.width(), 13);
assert!(v.capacity() >= 4);

Panics

May panic if the capacity would exceed the maximum length.

pub fn size_by_params(capacity: usize, width: usize) -> usize

Returns the size of a serialized vector with the given parameters in u64 elements.

Arguments

• capacity: Minimum capacity of the vector in items.
• width: Width of each item in bits.

Examples

use simple_sds_sbwt::int_vector::IntVector;

assert_eq!(IntVector::size_by_params(12, 31), 10);

Panics

May panic if the vector would exceed the maximum length.

Trait Implementations

impl<'a> Access<'a> for IntVector

type Iter = AccessIter<'a, IntVector>

Iterator over the items in the vector.

fn get(&self, index: usize) -> <Self as Vector>::Item

Returns an item from the vector.

fn iter(&'a self) -> Self::Iter

Returns an iterator over the items in the vector.

fn is_mutable(&self) -> bool

Returns true if the underlying data is mutable.

fn set(&mut self, index: usize, value: <Self as Vector>::Item)

Sets an item in the vector.

fn get_or( &self, index: usize, value: <Self as Vector>::Item, ) -> <Self as Vector>::Item

Returns an item from the vector or the provided value if index is invalid.

impl AsRef<RawVector> for IntVector

fn as_ref(&self) -> &RawVector

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for IntVector

fn clone(&self) -> IntVector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IntVector

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

Formats the value using the given formatter.

impl Default for IntVector

fn default() -> Self

Returns the “default value” for a type.

impl Extend<u16> for IntVector

fn extend<I: IntoIterator<Item = u16>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u32> for IntVector

fn extend<I: IntoIterator<Item = u32>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u64> for IntVector

fn extend<I: IntoIterator<Item = u64>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u8> for IntVector

fn extend<I: IntoIterator<Item = u8>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<usize> for IntVector

fn extend<I: IntoIterator<Item = usize>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<IntVector> for RawVector

fn from(source: IntVector) -> Self

Converts to this type from the input type.

impl From<Vec<u16>> for IntVector

fn from(v: Vec<u16>) -> Self

Converts to this type from the input type.

impl From<Vec<u32>> for IntVector

fn from(v: Vec<u32>) -> Self

Converts to this type from the input type.

impl From<Vec<u64>> for IntVector

fn from(v: Vec<u64>) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for IntVector

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<Vec<usize>> for IntVector

fn from(v: Vec<usize>) -> Self

Converts to this type from the input type.

impl FromIterator<u16> for IntVector

fn from_iter<I: IntoIterator<Item = u16>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<u32> for IntVector

fn from_iter<I: IntoIterator<Item = u32>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<u64> for IntVector

fn from_iter<I: IntoIterator<Item = u64>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<u8> for IntVector

fn from_iter<I: IntoIterator<Item = u8>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<usize> for IntVector

fn from_iter<I: IntoIterator<Item = usize>>(iter: I) -> Self

Creates a value from an iterator.

impl IntoIterator for IntVector

type Item = <IntVector as Vector>::Item

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Pack for IntVector

fn pack(&mut self)

Try to store the items of the vector more space-efficiently.

impl PartialEq for IntVector

fn eq(&self, other: &IntVector) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Pop for IntVector

fn pop(&mut self) -> Option<<Self as Vector>::Item>

Removes and returns the last item from the vector.

impl Push for IntVector

fn push(&mut self, value: <Self as Vector>::Item)

Appends an item to the vector.

impl Resize for IntVector

fn resize(&mut self, new_len: usize, value: <Self as Vector>::Item)

Resizes the vector to a specified length.

fn clear(&mut self)

Clears the vector without freeing the data.

fn capacity(&self) -> usize

Returns the number of items that the vector can store without reallocations.

fn reserve(&mut self, additional: usize)

Reserves space for storing at least self.len() + additional items in the vector.

impl Serialize for IntVector

fn serialize_header<T: Write>(&self, writer: &mut T) -> Result<()>

Serializes the header to the writer.

fn serialize_body<T: Write>(&self, writer: &mut T) -> Result<()>

Serializes the body to the writer.

fn load<T: Read>(reader: &mut T) -> Result<Self>

Loads the struct from the reader.

fn size_in_elements(&self) -> usize

Returns the size of the serialized struct in u64 elements.

fn serialize<T: Write>(&self, writer: &mut T) -> Result<()>

Serializes the struct to the writer.

fn size_in_bytes(&self) -> usize

Returns the size of the serialized struct in bytes.

impl Vector for IntVector

type Item = u64

The type of the items in the vector.

fn len(&self) -> usize

Returns the number of items in the vector.

fn width(&self) -> usize

Returns the width of of an item in bits.

fn max_len(&self) -> usize

Returns the maximum length of the vector.

fn is_empty(&self) -> bool

Returns true if the vector is empty.

impl Eq for IntVector

impl StructuralPartialEq for IntVector