Struct SearchParams

pub struct SearchParams(pub cuvsCagraSearchParams_t);

Supplemental parameters to search CAGRA index

Tuple Fields

0: cuvsCagraSearchParams_t

Implementations

impl SearchParams

pub fn new() -> Result<SearchParams>

Returns a new SearchParams object

pub fn set_max_queries(self, max_queries: usize) -> SearchParams

Maximum number of queries to search at the same time (batch size). Auto select when 0

pub fn set_itopk_size(self, itopk_size: usize) -> SearchParams

Number of intermediate search results retained during the search. This is the main knob to adjust trade off between accuracy and search speed. Higher values improve the search accuracy

pub fn set_max_iterations(self, max_iterations: usize) -> SearchParams

Upper limit of search iterations. Auto select when 0.

pub fn set_algo(self, algo: SearchAlgo) -> SearchParams

Which search implementation to use.

pub fn set_team_size(self, team_size: usize) -> SearchParams

Number of threads used to calculate a single distance. 4, 8, 16, or 32.

pub fn set_min_iterations(self, min_iterations: usize) -> SearchParams

Lower limit of search iterations.

pub fn set_thread_block_size(self, thread_block_size: usize) -> SearchParams

Thread block size. 0, 64, 128, 256, 512, 1024. Auto selection when 0.

pub fn set_hashmap_mode(self, hashmap_mode: HashMode) -> SearchParams

Hashmap type. Auto selection when AUTO.

pub fn set_hashmap_min_bitlen(self, hashmap_min_bitlen: usize) -> SearchParams

Lower limit of hashmap bit length. More than 8.

pub fn set_hashmap_max_fill_rate( self, hashmap_max_fill_rate: f32, ) -> SearchParams

Upper limit of hashmap fill rate. More than 0.1, less than 0.9.

pub fn set_num_random_samplings(self, num_random_samplings: u32) -> SearchParams

Number of iterations of initial random seed node selection. 1 or more.

pub fn set_rand_xor_mask(self, rand_xor_mask: u64) -> SearchParams

Bit mask used for initial random seed node selection.

Trait Implementations

impl Debug for SearchParams

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

Formats the value using the given formatter.

impl Drop for SearchParams

fn drop(&mut self)

Executes the destructor for this type.