Struct HNSW

pub struct HNSW { /* private fields */ }

Build a HNSW graph.

Currently, the HNSW graph is fully built in memory.

During the build, the graph is built layer by layer.

Each node in the graph has a global ID which is the index on the base layer.

Implementations

impl HNSW

pub fn empty() -> Self

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn max_level(&self) -> u16

pub fn num_nodes(&self, level: usize) -> usize

pub fn nodes(&self) -> Arc<Vec<RwLock<GraphBuilderNode>>>

pub fn search_inner( &self, query: ArrayRef, k: usize, ef: usize, bitset: Option<Visited<'_>>, visited_generator: &mut VisitedGenerator, storage: &impl VectorStore, prefetch_distance: Option<usize>, ) -> Result<Vec<OrderedNode>>

pub fn search_basic( &self, query: ArrayRef, k: usize, ef: usize, bitset: Option<Visited<'_>>, storage: &impl VectorStore, ) -> Result<Vec<OrderedNode>>

pub fn metadata(&self) -> HnswMetadata

Returns the metadata of this HNSW.

Trait Implementations

impl Clone for HNSW

fn clone(&self) -> HNSW

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HNSW

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

Formats the value using the given formatter.

impl DeepSizeOf for HNSW

fn deep_size_of_children(&self, context: &mut Context) -> usize

Returns an estimation of the heap-managed storage of this object. This does not include the size of the object itself.

fn deep_size_of(&self) -> usize

Returns an estimation of a total size of memory owned by the object, including heap-managed storage.

impl IvfSubIndex for HNSW

fn schema() -> SchemaRef

Return the schema of the sub index

fn index_vectors( storage: &impl VectorStore, params: Self::BuildParams, ) -> Result<Self>

where Self: Sized,

Given a vector storage, containing all the data for the IVF partition, build the sub index.

fn to_batch(&self) -> Result<RecordBatch>

Encode the sub index into a record batch

type BuildParams = HnswBuildParams

type QueryParams = HnswQueryParams

fn load(data: RecordBatch) -> Result<Self>

where Self: Sized,

Load the sub index from a record batch with a single row

fn name() -> &'static str

fn metadata_key() -> &'static str

fn search( &self, query: ArrayRef, k: usize, params: Self::QueryParams, storage: &impl VectorStore, prefilter: Arc<dyn PreFilter>, ) -> Result<RecordBatch>

Search the sub index for nearest neighbors.

fn remap(&self, _mapping: &HashMap<u64, Option<u64>>) -> Result<Self>