Struct akd::node_label::NodeLabel

pub struct NodeLabel {
    pub label_val: [u8; 32],
    pub label_len: u32,
}

The NodeLabel struct represents the label for a TreeNode. Since the label itself may have any number of zeros pre-pended, just using a native type, unless it is a bit-vector, wouldn’t work. Hence, we need a custom representation.

Fields

label_val: [u8; 32]

val stores a binary string as an array of 32 bytes

label_len: u32

len keeps track of how long the binary string actually is, since there may be extra 0s in the val

Implementations

impl NodeLabel

pub fn root() -> Self

Creates a new NodeLabel representing the root.

pub fn new(val: [u8; 32], len: u32) -> Self

Creates a new NodeLabel with the given value and len.

pub fn get_len(&self) -> u32

Gets the length of a NodeLabel.

pub fn get_val(&self) -> [u8; 32]

Gets the value of a NodeLabel.

pub fn get_longest_common_prefix(&self, other: Self) -> Self

Takes as input a pointer to the caller and another NodeLabel, returns a NodeLabel that is the longest common prefix of the two.

pub fn get_longest_common_prefix_and_dirs(
    &self,
    other: Self
) -> (Self, Direction, Direction)

Takes as input a pointer to self, another NodeLabel and returns the tuple representing:

• the longest common prefix,
• the direction, with respect to the longest common prefix, of other,
• the direction, with respect to the longest common prefix, of self. If either the node itself, or other is the longest common prefix, the direction of the longest common prefix node is None.

pub fn get_dir(&self, other: Self) -> Direction

Gets the direction of other with respect to self, if self is a prefix of other. If self is not a prefix of other, then returns None.

Trait Implementations

impl Clone for NodeLabel

fn clone(&self) -> NodeLabel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeLabel

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

Formats the value using the given formatter.

impl Display for NodeLabel

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

Formats the value using the given formatter.

impl Hash for NodeLabel

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for NodeLabel

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<NodeLabel> for NodeLabel

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

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

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

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

impl PartialOrd<NodeLabel> for NodeLabel

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

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

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

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

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

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

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

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

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 Copy for NodeLabel

impl Eq for NodeLabel

impl StructuralEq for NodeLabel

impl StructuralPartialEq for NodeLabel