Skip to main content

EmbeddingIndexMerger

Struct EmbeddingIndexMerger 

Source
pub struct EmbeddingIndexMerger {
    pub config: MergeConfig,
}
Expand description

Merges multiple partial HNSW embedding index shards into a unified index.

§Example

use ipfrs_semantic::index_merger::{
    EmbeddingIndexMerger, IndexShard, MergeConfig, ShardEntry,
};

let config = MergeConfig::default();
let merger = EmbeddingIndexMerger::new(config);

let shard = IndexShard::new(
    "node-1",
    vec![ShardEntry::new(1, vec![1.0_f32, 0.0], "doc-a")],
    2,
);

let (entries, stats) = merger.merge(&[shard]).expect("merge failed");
assert_eq!(entries.len(), 1);
assert_eq!(stats.output_entries, 1);

Fields§

§config: MergeConfig

Configuration for this merger instance.

Implementations§

Source§

impl EmbeddingIndexMerger

Source

pub fn new(config: MergeConfig) -> Self

Creates a new EmbeddingIndexMerger with the supplied configuration.

Source

pub fn merge( &self, shards: &[IndexShard], ) -> Result<(Vec<ShardEntry>, MergeStats), MergeConflict>

Merges the provided shards into a single flat list of ShardEntry values.

§Algorithm
  1. Each shard is validated; a dimension mismatch causes an immediate Err.
  2. Entries are walked in shard order. A HashMap<u64, usize> maps each seen embedding ID to its current position in the output vector.
  3. On a duplicate ID the cosine distance between the stored vector and the incoming vector is computed:
    • Distance > conflict_thresholdMergeConflict::DuplicateId is appended to stats.conflicts; the new entry is always skipped.
    • Distance ≤ conflict_threshold → near-identical copy; skipped silently.
    • When keep_first = false the existing slot is overwritten regardless of whether the conflict was recorded.
  4. If adding a new (non-duplicate) entry would push the output beyond max_entries, Err(CapacityExceeded) is returned immediately.

Returns (merged_entries, stats) on success.

Source

pub fn cosine_distance(a: &[f32], b: &[f32]) -> f32

Computes the cosine distance between two vectors.

cosine_distance = 1.0 - cosine_similarity

Returns 1.0 when either vector has zero norm (undefined similarity).

Source

pub fn shard_coverage(shards: &[IndexShard]) -> Vec<(String, usize)>

Returns a list of (shard_id, entry_count) pairs sorted by entry count in descending order.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

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

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more