Struct HnswIndexConfig 

pub struct HnswIndexConfig {
    pub max_neighbors: u16,
    pub ef_construction: u16,
}

HNSW construction parameters for native vector indexes.

max_neighbors is the HNSW M fanout. Layer zero may store up to 2 * max_neighbors links, while upper layers store up to max_neighbors. ef_construction is the candidate beam width used while inserting vectors.

Fields

max_neighbors: u16

HNSW M fanout for upper-layer neighbor lists.

ef_construction: u16

Candidate beam width used when constructing HNSW links.

Implementations

impl HnswIndexConfig

pub const DEFAULT_MAX_NEIGHBORS: u16 = 18

Default HNSW M fanout.

pub const DEFAULT_EF_CONSTRUCTION: u16 = 64

Default HNSW construction beam width.

pub const DEFAULT: HnswIndexConfig

Default HNSW construction configuration.

pub const fn new(max_neighbors: u16, ef_construction: u16) -> HnswIndexConfig

Construct a configuration without validation.

The graph layer validates bounds because it owns index memory policy.

pub const fn is_default(self) -> bool

Return true when this config is the engine default.

Trait Implementations

impl Archive for HnswIndexConfig

where u16: Archive,

const COPY_OPTIMIZATION: CopyOptimization<HnswIndexConfig>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedHnswIndexConfig

The archived representation of this type.

type Resolver = HnswIndexConfigResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve( &self, resolver: <HnswIndexConfig as Archive>::Resolver, out: Place<<HnswIndexConfig as Archive>::Archived>, )

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for HnswIndexConfig

fn clone(&self) -> HnswIndexConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HnswIndexConfig

impl Debug for HnswIndexConfig

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

Formats the value using the given formatter.

impl Default for HnswIndexConfig

fn default() -> HnswIndexConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HnswIndexConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<HnswIndexConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D> Deserialize<HnswIndexConfig, __D> for <HnswIndexConfig as Archive>::Archived

where __D: Fallible + ?Sized, u16: Archive, <u16 as Archive>::Archived: Deserialize<u16, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<HnswIndexConfig, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Eq for HnswIndexConfig

impl Hash for HnswIndexConfig

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HnswIndexConfig

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

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

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

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

impl Serialize for HnswIndexConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<__S> Serialize<__S> for HnswIndexConfig

where __S: Fallible + ?Sized, u16: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<HnswIndexConfig as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl StructuralPartialEq for HnswIndexConfig