diskann_disk::build::configuration::disk_index_build_parameter

Struct DiskIndexBuildParameters

pub struct DiskIndexBuildParameters { /* private fields */ }

Expand description

Parameters specific for disk index construction.

Implementations§

Source §

impl DiskIndexBuildParameters

Source

pub fn new( build_memory_limit: MemoryBudget, build_quantization: QuantizationType, search_pq_chunks: NumPQChunks, ) -> Self

Create new build parameters from already validated components.

Source

pub fn build_memory_limit(&self) -> MemoryBudget

Get the configured memory budget for index building.

Source

pub fn build_quantization(&self) -> &QuantizationType

Get quantization type used to instantiate quantized DataProvider for DiskANN Index during build

Source

pub fn search_pq_chunks(&self) -> NumPQChunks

Get user specified PQ chunks count for in-memory search data.

Trait Implementations§

Source §

impl Clone for DiskIndexBuildParameters

Source §

fn clone(&self) -> DiskIndexBuildParameters

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 DiskIndexBuildParameters

Source §

impl Debug for DiskIndexBuildParameters

Source §

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

Formats the value using the given formatter. Read more

Source §

impl PartialEq for DiskIndexBuildParameters

Source §

fn eq(&self, other: &DiskIndexBuildParameters) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Source §

impl StructuralPartialEq for DiskIndexBuildParameters

Auto Trait Implementations§

§

impl UnwindSafe for DiskIndexBuildParameters

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> AsyncFriendly for T
where T: Send + Sync + 'static,

Source §

impl<T> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

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> ByRef<T> for T

Source §

fn by_ref(&self) -> &T

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> Generator<T> for T
where T: Clone,

Source §

fn generate(&mut self) -> T

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §