Struct Node 

pub struct Node {
    pub group_path: String,
    pub child_key: String,
    /* private fields */
}

One node’s embeddings and child ids, read from the store on first use and then kept in memory.

Fields

group_path: String

The node’s group in the store, such as /lvl_2/node_7.

child_key: String

node_ids for an internal node, item_ids for a leaf.

Implementations

impl Node

pub fn new( store: ReadableListableStorage, group_path: String, child_key: String, ) -> Self

Creates a Node for the group at group_path. Nothing is read until embeddings or children is called.

pub fn embeddings(&self) -> Result<Option<&Array2<f32>>>

Returns the node’s embeddings as f32, reading them on the first call. Ok(None) if the node was never written, Err if the read failed. Both results are cached.

pub fn children(&self) -> Result<Option<&Array1<u32>>>

Returns the node’s child ids as u32, reading them on the first call. Ok(None) means the node was never written, Err if the read failed. Both results are cached.

pub fn is_loaded(&self) -> bool

Checks whether embeddings or children has read data. Always false for a node missing on disk or one whose read failed.

pub fn resident_bytes(&self) -> usize

Returns the bytes of embeddings and child ids this node holds in memory, which the node cache counts against its limit.