Struct VectorIndex 

pub struct VectorIndex { /* private fields */ }

Built-in vector index state for one (label, property) registration.

Implementations

impl VectorIndex

pub fn new(kind: VectorIndexKind, dimension: u32) -> GraphResult<Self>

Construct an empty vector index.

Errors

Returns GraphError::VectorIndexInvalidDimension when dimension is zero.

pub fn new_with_hnsw_config( kind: VectorIndexKind, dimension: u32, hnsw_config: Option<HnswIndexConfig>, ) -> GraphResult<Self>

Construct an empty vector index with optional HNSW configuration.

Errors

Returns GraphError::VectorIndexInvalidDimension when dimension is zero, or GraphError::VectorIndexInvalidHnswConfig when the supplied HNSW parameters are invalid for the chosen kind.

pub fn new_with_configs( kind: VectorIndexKind, dimension: u32, hnsw_config: Option<HnswIndexConfig>, ivf_config: Option<IvfIndexConfig>, ) -> GraphResult<Self>

Construct an empty vector index with optional ANN construction config.

Errors

Returns GraphError::VectorIndexInvalidDimension when dimension is zero, GraphError::VectorIndexInvalidHnswConfig when supplied HNSW parameters are invalid for the chosen kind, or GraphError::VectorIndexInvalidIvfConfig when supplied IVF parameters are invalid for the chosen kind.

pub const fn kind(&self) -> VectorIndexKind

Return the vector index algorithm kind.

pub const fn dimension(&self) -> u32

Return the required vector dimensionality.

pub const fn hnsw_config(&self) -> Option<HnswIndexConfig>

Return the HNSW construction config, if this is an HNSW index.

pub const fn ivf_config(&self) -> Option<IvfIndexConfig>

Return the IVF construction config, if this is a configured IVF index.

pub fn cardinality(&self) -> u64

Return the number of indexed rows.

pub const fn rows(&self) -> &RoaringBitmap

Borrow the indexed row bitmap.

pub const fn is_hnsw(&self) -> bool

Return true when this index has an ANN graph.

pub const fn is_ivf(&self) -> bool

Return true when this index has an IVF accelerator.

pub const fn is_turbo_quant(&self) -> bool

Return true when this index has a TurboQuant compressed accelerator.

pub const fn hnsw_metric(&self) -> Option<VectorMetric>

Return the HNSW metric, if this is an HNSW index.

pub const fn ann_metric(&self) -> Option<VectorMetric>

Return the ANN metric, if this is an approximate index.

pub fn memory_usage(&self) -> VectorIndexMemoryUsage

Return an estimated memory usage snapshot for this index.

Trait Implementations

impl Clone for VectorIndex

fn clone(&self) -> VectorIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorIndex

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

Formats the value using the given formatter.