Struct rpds::vector::Vector

pub struct Vector<T> { /* fields omitted */ }

A persistent vector with structural sharing.

Complexity

Let n be the number of elements in the vector.

Temporal complexity

Operation	Average	Worst case
new()	Θ(1)	Θ(1)
set()	Θ(log(n))	Θ(log(n))
push_back()	Θ(log(n))	Θ(log(n))
drop_last()	Θ(log(n))	Θ(log(n))
first()/last()/get()	Θ(log(n))	Θ(log(n))
len()	Θ(1)	Θ(1)
clone()	Θ(1)	Θ(1)
iterator creation	Θ(1)	Θ(1)
iterator step	Θ(1)	Θ(log(n))
iterator full	Θ(n)	Θ(n)

Proof sketch of the complexity of full iteration

1. A tree of size n and degree d has height ⌈log_d(n)⌉ - 1.
2. A complete iteration is a depth-first search on the tree.
3. A depth-first search has complexity Θ(|V| + |E|), where |V| is the number of nodes and |E| the number of edges.
4. The number of nodes |V| for a complete tree of height h is the sum of powers of d, which is (dʰ - 1) / (d - 1). See Calculating sum of consecutive powers of a number.
5. The number of edges is exactly |V| - 1.

By 2. and 3. we have that the complexity of a full iteration is

     Θ(|V| + |E|)
   = Θ((dʰ - 1) / (d - 1))      (by 4. and 5.)
   = Θ(dʰ)
   = Θ(n)                       (by 1.)

Implementation details

This implementation uses a bitmapped vector trie as described in Understanding Persistent Vector Part 1 and Understanding Persistent Vector Part 2.

Methods

impl<T> Vector<T>

#[must_use]

pub fn new() -> Vector<T>

#[must_use]

pub fn new_with_bits(bits: u8) -> Vector<T>

#[must_use]

pub fn first(&self) -> Option<&T>

#[must_use]

pub fn last(&self) -> Option<&T>

#[must_use]

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

#[must_use]

pub fn set(&self, index: usize, v: T) -> Option<Vector<T>>

pub fn set_mut(&mut self, index: usize, v: T) -> bool

Returns true if the operation was successful.

#[must_use]

pub fn push_back(&self, v: T) -> Vector<T>

pub fn push_back_mut(&mut self, v: T)

#[must_use]

pub fn drop_last(&self) -> Option<Vector<T>>

pub fn drop_last_mut(&mut self) -> bool

#[must_use]

pub fn len(&self) -> usize

#[must_use]

pub fn is_empty(&self) -> bool

#[must_use]

pub fn iter(&self) -> Iter<T>

impl<T: Clone> Vector<T>

#[must_use]

pub fn get_mut(&mut self, index: usize) -> Option<&mut T>

Gets a mutable reference to an element. If the element is shared, it will be cloned. Returns None if and only if the given index is out of range.

Trait Implementations

impl<T> Default for Vector<T>

fn default() -> Vector<T>

Returns the "default value" for a type.

impl<T> Clone for Vector<T>

fn clone(&self) -> Vector<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Ord> Ord for Vector<T>

fn cmp(&self, other: &Vector<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<'a, T> IntoIterator for &'a Vector<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, T>

Creates an iterator from a value.

impl<T: Eq> Eq for Vector<T>

impl<T> Extend<T> for Vector<T>

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

Extends a collection with the contents of an iterator.

impl<T: PartialOrd<U>, U> PartialOrd<Vector<U>> for Vector<T>

fn partial_cmp(&self, other: &Vector<U>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: PartialEq<U>, U> PartialEq<Vector<U>> for Vector<T>

fn eq(&self, other: &Vector<U>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<T> Display for Vector<T> where
    T: Display, 

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Hash> Hash for Vector<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T> Index<usize> for Vector<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &T

Performs the indexing (container[index]) operation.

impl<T: Clone> IndexMut<usize> for Vector<T>

fn index_mut(&mut self, index: usize) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T> FromIterator<T> for Vector<T>

fn from_iter<I: IntoIterator<Item = T>>(into_iter: I) -> Vector<T>

Creates a value from an iterator.

impl<T: Debug> Debug for Vector<T>

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

Formats the value using the given formatter.

impl<T> Serialize for Vector<T> where
    T: Serialize, 

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<'de, T> Deserialize<'de> for Vector<T> where
    T: Deserialize<'de>, 

fn deserialize<D: Deserializer<'de>>(
    deserializer: D
) -> Result<Vector<T>, D::Error>

Deserialize this value from the given Serde deserializer.