Struct mih_rs::mih::Index

pub struct Index<'db> { /* fields omitted */ }

An index implementation of MIH.

Implementations

impl<'_> Index<'_>

pub fn new<'db>(codes: &'db [u64]) -> Result<Index, Error>

Constructs the index from 64-bit codes. If invalid inputs are given, return ErrorKind::InvalidInput.

pub fn new_with_blocks<'db>(
    codes: &'db [u64],
    blocks: usize
) -> Result<Index, Error>

Constructs the index from 64-bit codes using manual parameter of blocks. If invalid inputs are given, return ErrorKind::InvalidInput.

pub fn range_search(&self, qcode: u64, radius: usize) -> Vec<usize>

Finds the neighbor codes whose Hamming distances to qcode are within radius. Returns the ids of the neighbor codes.

pub fn range_search_with_buf(
    &self,
    qcode: u64,
    radius: usize,
    answers: &mut Vec<usize>
)

Finds the neighbor codes whose Hamming distances to qcode are within radius. The ids of the neighbor codes are stored in answers.

pub fn topk_search(&self, qcode: u64, topk: usize) -> Vec<usize>

Finds the topk codes that are closest to qcode. Returns the ids of the topk codes.

pub fn topk_search_with_buf(
    &self,
    qcode: u64,
    topk: usize,
    answers: &mut Vec<usize>
)

Finds the topk codes that are closest to qcode. The ids of the topk codes are stored in answers.