Struct sucds::compact_vector::CompactVector

pub struct CompactVector { /* private fields */ }

Compact vector in which each integer is represented in a fixed number of bits.

Examples

use sucds::CompactVector;

let cv = CompactVector::from_slice(&[5, 256, 0, 10]);

assert_eq!(cv.get(0), 5);
assert_eq!(cv.get(1), 256);
assert_eq!(cv.get(2), 0);
assert_eq!(cv.get(3), 10);

assert_eq!(cv.len(), 4);
assert_eq!(cv.width(), 9);

let mut bytes = vec![];
let size = cv.serialize_into(&mut bytes).unwrap();
let other = CompactVector::deserialize_from(&bytes[..]).unwrap();
assert_eq!(cv, other);
assert_eq!(size, bytes.len());
assert_eq!(size, cv.size_in_bytes());

Implementations

impl CompactVector

pub fn new(width: usize) -> Self

Creates a new empty CompactVector.

Arguments

• width: Number of bits to represent an integer.

pub fn with_len(len: usize, width: usize) -> Self

Creates a new CompactVector of len integers.

Arguments

• len: Number of integers to be stored.
• width: Number of bits to represent an integer.

pub fn with_capacity(capa: usize, width: usize) -> Self

Creates a new CompactVector that capa integers are reserved.

Arguments

• capa: Number of integers to be reserved.
• width: Number of bits to represent an integer.

pub fn from_slice(ints: &[usize]) -> Self

Creates a new CompactVector from a slice of integers.

Arguments

• ints: Integers to be stored.

Examples

use sucds::CompactVector;

let cv = CompactVector::from_slice(&[5, 256, 0, 10]);
assert_eq!(cv.get(0), 5);
assert_eq!(cv.get(1), 256);
assert_eq!(cv.get(2), 0);
assert_eq!(cv.get(3), 10);

pub fn serialize_into<W: Write>(&self, writer: W) -> Result<usize>

Serializes the data structure into the writer, returning the number of serialized bytes.

Arguments

• writer: std::io::Write variable.

pub fn deserialize_from<R: Read>(reader: R) -> Result<Self>

Deserializes the data structure from the reader.

Arguments

• reader: std::io::Read variable.

pub fn size_in_bytes(&self) -> usize

Returns the number of bytes to serialize the data structure.

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

Gets the pos-th integer.

Arguments

• pos: Position.

Examples

use sucds::CompactVector;

let cv = CompactVector::from_slice(&[5, 256, 0, 10]);
assert_eq!(cv.get(0), 5);
assert_eq!(cv.get(1), 256);
assert_eq!(cv.get(2), 0);
assert_eq!(cv.get(3), 10);

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

Sets the pos-th integer to value.

Arguments

• pos: Position.
• value: Integer to be set.

Examples

use sucds::CompactVector;

let mut cv = CompactVector::with_len(2, 8);
cv.set(0, 10);
cv.set(1, 255);
assert_eq!(cv.get(0), 10);
assert_eq!(cv.get(1), 255);

pub fn push(&mut self, value: usize)

Pushes integer value at the end.

Arguments

• value: Integer to be set.

Examples

use sucds::CompactVector;

let mut cv = CompactVector::new(8);
cv.push(10);
cv.push(255);
assert_eq!(cv.get(0), 10);
assert_eq!(cv.get(1), 255);

pub const fn len(&self) -> usize

Gets the number of ints.

pub const fn is_empty(&self) -> bool

Checks if the vector is empty.

pub const fn width(&self) -> usize

Gets the number of bits to represent an integer.

Trait Implementations

impl Clone for CompactVector

fn clone(&self) -> CompactVector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompactVector

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

Formats the value using the given formatter.

impl Default for CompactVector

fn default() -> CompactVector

Returns the “default value” for a type.

impl PartialEq<CompactVector> for CompactVector

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for CompactVector

impl StructuralEq for CompactVector

impl StructuralPartialEq for CompactVector