Struct bintrie::SearchHeuristic

pub struct SearchHeuristic<F>(pub F, pub bool);

Chooses paths to search down.

Wrap a type with the bound F: FnMut(bool) -> bool + Clone and this will implement Heuristic. The second argument has to be the first choice. The function will be cloned internally so that from the function's point of view it is being called in the order it descends in. It is passed the side that is being entered and returns which side it would like to enter next.

This is not particularly useful for most applications, but if you want to search different halves of a binary tree first, this is correct. This could be used to make an approximate nearest-neighbor (ANN) solution, but the quality of the match would then be fixed and depend on which bits differed between two matches (more significant bits differing would throw it out).

Trait Implementations

impl<F> Heuristic for SearchHeuristic<F> where
    F: FnMut(bool) -> bool + Clone, 

type Iter = Cloned<Iter<'static, bool>>

fn enter(&mut self, side: bool)

This is passed the side.

fn iter(&self) -> Self::Iter

Must return an iterator which returns values below 16, otherwise panics.

impl<F: Clone> Clone for SearchHeuristic<F>

fn clone(&self) -> SearchHeuristic<F>

Returns a copy of the value.

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

Performs copy-assignment from source.