Skip to main content

cuvsVamanaIndexParams

Struct cuvsVamanaIndexParams 

Source
#[repr(C)]
pub struct cuvsVamanaIndexParams { pub metric: cuvsDistanceType, pub graph_degree: u32, pub visited_size: u32, pub vamana_iters: f32, pub alpha: f32, pub max_fraction: f32, pub batch_base: f32, pub queue_size: u32, pub reverse_batchsize: u32, }
Expand description

@brief Supplemental parameters to build Vamana Index

graph_degree: Maximum degree of graph; corresponds to the R parameter of Vamana algorithm in the literature. visited_size: Maximum number of visited nodes per search during Vamana algorithm. Loosely corresponds to the L parameter in the literature. vamana_iters: The number of times all vectors are inserted into the graph. If > 1, all vectors are re-inserted to improve graph quality. max_fraction: The maximum batch size is this fraction of the total dataset size. Larger gives faster build but lower graph quality. alpha: Used to determine how aggressive the pruning will be.

Fields§

§metric: cuvsDistanceType

Distance type.

§graph_degree: u32

Maximum degree of output graph corresponds to the R parameter in the original Vamana literature.

§visited_size: u32

Maximum number of visited nodes per search corresponds to the L parameter in the Vamana literature

§vamana_iters: f32

Number of Vamana vector insertion iterations (each iteration inserts all vectors).

§alpha: f32

Alpha for pruning parameter

§max_fraction: f32

Maximum fraction of dataset inserted per batch. * Larger max batch decreases graph quality, but improves speed

§batch_base: f32

Base of growth rate of batch sizes

§queue_size: u32

Size of candidate queue structure - should be (2^x)-1

§reverse_batchsize: u32

Max batchsize of reverse edge processing (reduces memory footprint)

Trait Implementations§

Source§

impl Clone for cuvsVamanaIndexParams

Source§

fn clone(&self) -> cuvsVamanaIndexParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for cuvsVamanaIndexParams

Source§

impl Debug for cuvsVamanaIndexParams

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.