Struct ProximityConfig

Source

pub struct ProximityConfig {
    pub dimensions: u32,
    pub metric: DistanceMetric,
    pub hierarchy: HierarchyConfig,
    pub overflow: OverflowConfig,
    pub vector_storage: VectorStorageConfig,
    pub scalar_quantization: Option<ScalarQuantizationConfig>,
}

Expand description

Shape-affecting configuration for a proximity map.

Fields§

§dimensions: u32

Number of finite f32 components in every stored and query vector.

§metric: DistanceMetric

Persisted distance metric.

§hierarchy: HierarchyConfig

Promotion and hierarchy shape.

§overflow: OverflowConfig

Physical node paging and limits.

§vector_storage: VectorStorageConfig

Representative vector storage policy.

§scalar_quantization: Option<ScalarQuantizationConfig>

Optional committed local routing quantization.

Implementations§

Source §

impl ProximityConfig

Source

pub fn new(dimensions: u32) -> Self

Construct a production-oriented squared-L2 configuration.

Source

pub fn validate(&self) -> Result<(), Error>

Validate all shape-affecting fields before reading or writing nodes.

Trait Implementations§

Source §

impl Clone for ProximityConfig

Source §

fn clone(&self) -> ProximityConfig

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 Debug for ProximityConfig

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Eq for ProximityConfig

Source §

impl PartialEq for ProximityConfig

Source §

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Source §

impl StructuralPartialEq for ProximityConfig

Auto Trait Implementations§

§

impl UnwindSafe for ProximityConfig

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 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 §