Struct vpsearch::Tree

pub struct Tree<Item: MetricSpace + Copy, Ownership> { /* fields omitted */ }

The VP-Tree.

Methods

impl<Item: MetricSpace<UserData=()> + Copy> Tree<Item, Owned<()>>

fn new(items: &[Item]) -> Self

Creates a new tree from items.

@see Tree::new_with_user_data_owned

impl<U, Item: MetricSpace<UserData=U> + Copy> Tree<Item, Owned<U>>

fn find_nearest(&self, needle: &Item) -> (usize, Item::Distance)

Finds item closest to given needle (that can be any item) and Output index of the item in items array from new().

@param needle The query. @return Index of the nearest item found and the distance from the nearest item

impl<Item: MetricSpace + Copy> Tree<Item, Owned<Item::UserData>>

fn new_with_user_data_owned(items: &[Item], user_data: Item::UserData) -> Self

Create a Vantage Point tree for fast nearest neighbor search.

@param items Array of items that will be searched. @param user_data Reference to any object that is passed down to item.distance()

impl<Item: MetricSpace + Copy> Tree<Item, UserDataByRef>

fn new_with_user_data_ref(items: &[Item], user_data: &Item::UserData) -> Self

The tree doesn't have to own the UserData. You can keep passing it to find_nearest().

fn find_nearest(&self,
                needle: &Item,
                user_data: &Item::UserData)
                -> (usize, Item::Distance)

impl<Item: MetricSpace + Copy, Ownership> Tree<Item, Ownership>

fn find_nearest_custom<ReturnBy: BestCandidate<Item>>(&self,
                                                      needle: &Item,
                                                      user_data: &Item::UserData,
                                                      best_candidate: ReturnBy)
                                                      -> ReturnBy::Output

All the bells and whistles version. For best_candidate implement BestCandidate<Item> trait.

Trait Implementations

impl<Item: Debug + Copy + MetricSpace, Ownership> Debug for Tree<Item, Ownership>

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

Formats the value using the given formatter.