Struct skew_forest::SkewPath

pub struct SkewPath<A: SkewPathArray> { /* fields omitted */ }

A path in a tree in a SkewForest. This can be seen as an index into a path in a specific SkewForest, and must therefore only be used with a single SkewForest.

The type parameter A denotes the path node array used internally by this path. The capacity of this path depends on the length of the array. If the length of this array is n then the capacity will be 2.pow(n) - 1.

The memory size and the cost of cloning a SkewPath is proportional to the length of the array.

Methods

impl<A: SkewPathArray> SkewPath<A>

pub fn last(&self) -> Option<SkewIndex<A::Idx>>

Return the last value in this path or None if the path is empty.

pub fn len(&self) -> usize

The number of nodes of this path.

pub fn is_empty(&self) -> bool

Returns true if there are no nodes in this path and false otherwise.

Trait Implementations

impl<A: SkewPathArray> Clone for SkewPath<A>

fn clone(&self) -> SkewPath<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: SkewPathArray> Debug for SkewPath<A>

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

Formats the value using the given formatter.

impl<A> Default for SkewPath<A> where
    A: SkewPathArray, 

fn default() -> Self

Returns the "default value" for a type.

impl<A: SkewPathArray> Eq for SkewPath<A>

impl<A: SkewPathArray> Ord for SkewPath<A>

fn cmp(&self, other: &SkewPath<A>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<A: SkewPathArray> PartialEq<SkewPath<A>> for SkewPath<A>

fn eq(&self, other: &SkewPath<A>) -> 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<A: SkewPathArray> PartialOrd<SkewPath<A>> for SkewPath<A>

fn partial_cmp(&self, other: &SkewPath<A>) -> 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.