pub struct HnswCodecIndex<C: VectorCodec> {
pub dim: usize,
pub m: usize,
pub m0: usize,
pub ef_construction: usize,
pub max_layer: usize,
pub entry_point: Option<u32>,
pub level_mult: f32,
pub codec: C,
/* private fields */
}Expand description
Hierarchical Navigable Small World graph index parameterised on a
VectorCodec.
- Upper-layer routing:
codec.fast_symmetric_distance - Base-layer rerank:
codec.exact_asymmetric_distance
Fields§
§dim: usize§m: usizeMax neighbors per node in upper layers.
m0: usizeMax neighbors per node at layer 0 (= m * 2).
ef_construction: usize§max_layer: usizeCurrent highest layer in the index.
entry_point: Option<u32>Dense index (insertion order) of the current entry-point node.
level_mult: f321.0 / ln(m) — used by random_layer.
codec: CImplementations§
Source§impl<C: VectorCodec> HnswCodecIndex<C>
impl<C: VectorCodec> HnswCodecIndex<C>
Source§impl<C: VectorCodec> HnswCodecIndex<C>
impl<C: VectorCodec> HnswCodecIndex<C>
Sourcepub fn new(
dim: usize,
m: usize,
ef_construction: usize,
codec: C,
seed: u64,
) -> Self
pub fn new( dim: usize, m: usize, ef_construction: usize, codec: C, seed: u64, ) -> Self
Create a new empty codec index.
pub fn is_empty(&self) -> bool
pub fn dim(&self) -> usize
Sourcepub fn random_layer(&mut self) -> usize
pub fn random_layer(&mut self) -> usize
Assign a random layer per the HNSW exponential distribution.
Capped at MAX_LAYER_CAP to prevent pathological draws from inflating
max_layer.
Sourcepub fn quantized_at(&self, idx: u32) -> Option<&C::Quantized>
pub fn quantized_at(&self, idx: u32) -> Option<&C::Quantized>
Return a reference to the quantized payload at idx, if present and
not deleted.
Sourcepub fn neighbors_at(&self, idx: u32, layer: usize) -> &[u32]
pub fn neighbors_at(&self, idx: u32, layer: usize) -> &[u32]
Return the neighbor slice for idx at layer.
Source§impl<C: VectorCodec> HnswCodecIndex<C>
impl<C: VectorCodec> HnswCodecIndex<C>
Auto Trait Implementations§
impl<C> Freeze for HnswCodecIndex<C>where
C: Freeze,
impl<C> RefUnwindSafe for HnswCodecIndex<C>
impl<C> Send for HnswCodecIndex<C>
impl<C> Sync for HnswCodecIndex<C>
impl<C> Unpin for HnswCodecIndex<C>
impl<C> UnsafeUnpin for HnswCodecIndex<C>where
C: UnsafeUnpin,
impl<C> UnwindSafe for HnswCodecIndex<C>
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Returns the layout of the type.
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Returns whether the given value has been niched. Read more
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
Writes data to
out indicating that a T is niched.Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.