Struct BKTree 

pub struct BKTree<T> { /* private fields */ }

Burkhard-Keller metric tree over 32-bit keys with Hamming distance.

Supports radius-bounded nearest-neighbor queries via triangle-inequality pruning. For phonetic fingerprints, typical query time at radius ≤ 4 over 10⁴-10⁶ entries is in the low milliseconds.

Example

use amt::{encode_token, BKTree};

let mut tree: BKTree<String> = BKTree::new();
for name in ["Khaled", "Khalid", "Ahmed", "Robert"] {
    let code = encode_token(name);
    for &sp in &code.spectrals {
        tree.add(sp, name.to_string());
    }
}

let query = encode_token("Khaleed");
let hits = tree.query(query.spectrals[0], 4);
assert!(hits.iter().any(|(_, name)| name.as_str() == "Khaled"));

Implementations

impl<T> BKTree<T>

pub fn new() -> Self

Create an empty tree.

pub fn len(&self) -> usize

Number of entries currently in the tree.

pub fn is_empty(&self) -> bool

True if the tree has no entries.

pub fn add(&mut self, key: u32, payload: T)

Insert (key, payload).

pub fn query(&self, key: u32, radius: u32) -> Vec<(u32, &T)>

Return all entries within radius Hamming distance of key, sorted by distance (closest first).

Trait Implementations

impl<T: Debug> Debug for BKTree<T>

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

Formats the value using the given formatter.

impl<T> Default for BKTree<T>

fn default() -> Self

Returns the “default value” for a type.