Struct NodeRef 

pub struct NodeRef(/* private fields */);

Packed reference to a tree node.

The high bit discriminates internal (0) from leaf (1) so node identity is a single 4-byte field — useful for cache-friendly storage in NodeStore.

Examples

use anomstream_core::ForestBuilder;

let forest = ForestBuilder::<2>::new()
    .num_trees(50)
    .sample_size(8)
    .seed(1)
    .build()
    .unwrap();
for (tree, _, _) in forest.trees() {
    assert!(tree.root().is_none()); // empty forest has no root yet
}

Implementations

impl NodeRef

pub const MAX_INDEX: u32 = Self::INDEX_MASK

Largest representable slot index ((1 << 31) − 1).

pub fn is_leaf(self) -> bool

Whether this reference points to a leaf.

pub fn is_internal(self) -> bool

Whether this reference points to an internal node.

pub fn index(self) -> usize

Slot index in the corresponding storage arena.

Trait Implementations

impl Clone for NodeRef

fn clone(&self) -> NodeRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeRef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for NodeRef

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 NodeRef

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for NodeRef

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for NodeRef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for NodeRef

impl Eq for NodeRef

impl StructuralPartialEq for NodeRef