Struct nutrimatic::Node

pub struct Node<'buf> { /* fields omitted */ }

A node in a trie.

Nodes implement ordering and equality according to their frequency in order to accommodate using them in priority queues for best-first search.

Examples

use nutrimatic::Node;

// This buffer represents a single node with three leaf children.
let buf: &[u8] = &[0x61, 0x11, 0x62, 0x12, 0x63, 0x13, 0x03];

let root = Node::new(buf);
// Print out all children of the root node of the trie.
for child in &root.children() {
    println!("{} {}", child.ch() as char, child.freq());
}

Implementations

impl<'buf> Node<'buf>

pub fn new(buf: &'buf [u8]) -> Node<'buf>

Constructs the root node of the trie serialized in the given buffer.

pub fn ch(&self) -> u8

Returns the character associated with the node—i.e., the letter used to transition from this node’s parent to this node.

This value is not useful for a root node returned by Node::new.

pub fn freq(&self) -> u64

Returns the frequency of the node—i.e., the total number of times that the corpus contains any phrase that starts with the sequence of characters corresponding to the path to this node (including this node’s own character).

pub fn children(&self) -> ChildReader<'buf>

Parses a node and returns an object representing the sequence of its children.

pub fn to_thin(&self) -> ThinNode<'buf>

Constructs a thin version of this node.

pub fn from_thin(&self, thin: ThinNode<'buf>) -> Node<'buf>

Reconstitutes a thin node into a full node.

The thin node must have originally been associated with the same index file buffer as this node.

pub fn search_string<'a, I>(&self, q: I) -> SearchResult<'buf> where
    I: IntoIterator<Item = &'a u8>, 

Searches multiple levels through the trie in one call.

pub fn word_freq<'a, I>(&self, word: I) -> Option<u64> where
    I: IntoIterator<Item = &'a u8>, 

Finds the frequency of the given sequence of characters in the trie.

This function performs a query for the given characters followed by a space character and returns the frequency of the final node, if found.

Trait Implementations

impl<'buf> Clone for Node<'buf>

fn clone(&self) -> Node<'buf>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'buf> Copy for Node<'buf>

impl<'buf> Debug for Node<'buf>

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

Formats the value using the given formatter.

impl Eq for Node<'_>

impl Ord for Node<'_>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Node<'_>> for Node<'_>

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Node<'_>> for Node<'_>

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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