Struct nutrimatic::ThinNode

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

A “thin” representation of a node in a trie.

ThinNode is like Node, but smaller (it omits the reference to the buffer containing the trie). It is intended to be used when there are a lot of nodes in memory at the same time and reducing their size is helpful for performance. Using only Node allows for slightly simpler code and should be done when the difference in performance (if any) doesn’t matter.

Thin nodes, like normal nodes, implement ordering and equality according to their frequency in order to accommodate using them in priority queues for best-first search.

Thin nodes are created by Node::to_thin and turned into normal nodes by Node::from_thin.

Implementations

impl<'buf> ThinNode<'buf>

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).

Trait Implementations

impl<'buf> Clone for ThinNode<'buf>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'buf> Copy for ThinNode<'buf>

impl<'buf> Debug for ThinNode<'buf>

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

Formats the value using the given formatter.

impl Eq for ThinNode<'_>

impl Ord for ThinNode<'_>

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<ThinNode<'_>> for ThinNode<'_>

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<ThinNode<'_>> for ThinNode<'_>

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.