Skip to main content

SparseIndex

Struct SparseIndex 

Source
pub struct SparseIndex { /* private fields */ }
Expand description

In-memory inverted index for sparse vectors.

Implementations§

Source§

impl SparseIndex

Source

pub fn new() -> Self

Source

pub fn from_parts( dim_map: HashMap<u32, usize>, dim_reverse: Vec<u32>, postings: Vec<Postings>, vectors: HashMap<u64, SparseVector>, ) -> Self

Reconstruct from stored parts (dims + vectors, postings separate).

Source

pub fn dim_map(&self) -> &HashMap<u32, usize>

Source

pub fn dim_reverse(&self) -> &[u32]

Source

pub fn postings(&self) -> &[Postings]

Source

pub fn postings_mut(&mut self) -> &mut Vec<Postings>

Source

pub fn vectors(&self) -> &HashMap<u64, SparseVector>

Source

pub fn set_vectors(&mut self, vectors: HashMap<u64, SparseVector>)

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn insert(&mut self, node_id: u64, vector: &SparseVector)

Index a record’s vector, replacing any previous vector under the same id. Zero weights are not indexed (see the module docs).

Source

pub fn remove(&mut self, node_id: u64) -> bool

Remove a record. Returns true if it existed.

Source

pub fn search(&self, query: &SparseVector, limit: usize) -> Vec<(u64, f32)>

Top-limit records by dot product with query, score descending then id ascending.

Source

pub fn search_filtered( &self, query: &SparseVector, limit: usize, allowed_ids: &[u64], ) -> Vec<(u64, f32)>

search restricted to allowed_ids.

Source

pub fn clear(&mut self)

Clear the entire index.

Trait Implementations§

Source§

impl Debug for SparseIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SparseIndex

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for SparseIndex

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SparseIndex

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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.