Enum gf::support::bitpat::BitPatTableNode

pub enum BitPatTableNode<T> {
    Accept {
        value: T,
    },
    Reject,
    Fork {
        prongs: Vec<BitPatTableNode<T>>,
    },
    Dense {
        mask: u128,
        table: Vec<BitPatTableNode<T>>,
    },
    Sparse {
        mask: u128,
        table: HashMap<u8, BitPatTableNode<T>>,
    },
}

A node in the decision tree of a BitPatTable.

The normal way of dealing with pattern tables does not require to use this structure directly, use BitPatTableBuilder instead.

Variants

Accept

Accept node.

Fields of Accept

value: T

Associated value.

Reject

Reject node.

Fork

Internal fork node.

Fields of Fork

prongs: Vec<BitPatTableNode<T>>

Links to nodes to be considered in order.

Dense

Internal dense node.

Fields of Dense

mask: u128

Mask of bits that form the lookup key; the mask may have at most 8 set bits.

table: Vec<BitPatTableNode<T>>

Link table, has 2ⁿ items where n is the number of set bits in mask.

Sparse

Internal sparse node.

Fields of Sparse

mask: u128

Mask of bits that form the lookup key; the mask may have at most 8 set bits.

table: HashMap<u8, BitPatTableNode<T>>

Link table; keys that have no values are assumed to be Reject.

Implementations

impl<T> BitPatTableNode<T>

pub fn get(&self, input: u128, input_bit_len: usize) -> Option<&T>

Query the subtree for an input, returning Some for an Accept node, and None for a Reject node.

Errors

• Panics if input_bit_len is greater than 128.

pub fn is_accept(&self) -> bool

Return whether this is an Accept node.

pub fn is_reject(&self) -> bool

Return whether this is a Reject node.

pub fn into_sparse(self) -> Self

Recursively replace Dense nodes which have more Reject items than non-Reject items with Sparse nodes.

Trait Implementations

impl<T: Clone> Clone for BitPatTableNode<T>

fn clone(&self) -> BitPatTableNode<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BitPatTableNode<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for BitPatTableNode<T>

impl<T: PartialEq> PartialEq<BitPatTableNode<T>> for BitPatTableNode<T>

fn eq(&self, other: &BitPatTableNode<T>) -> bool

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

fn ne(&self, other: &BitPatTableNode<T>) -> bool

This method tests for !=.

impl<T> StructuralEq for BitPatTableNode<T>

impl<T> StructuralPartialEq for BitPatTableNode<T>