Struct FlatIndex 

pub struct FlatIndex {
    pub dim: usize,
    pub data: Vec<Vector>,
}

Flat index implementation for exact vector search

This index stores vectors in a simple array and performs linear search to find the most similar vectors. While slower than approximate methods, it guarantees exact results.

Examples

use vectorlite::{FlatIndex, Vector, SimilarityMetric, VectorIndex};

let mut index = FlatIndex::new(3, Vec::new());
let vector = Vector { id: 1, values: vec![1.0, 2.0, 3.0] };
 
index.add(vector)?;
let results = index.search(&[1.1, 2.1, 3.1], 5, SimilarityMetric::Cosine);

Fields

dim: usize

Dimension of vectors stored in this index

data: Vec<Vector>

Storage for all vectors

Implementations

impl FlatIndex

pub fn new(dim: usize, data: Vec<Vector>) -> Self

pub fn max_id(&self) -> Option<u64>

Get the maximum ID from the stored vectors

Trait Implementations

impl Clone for FlatIndex

fn clone(&self) -> FlatIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlatIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FlatIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FlatIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl VectorIndex for FlatIndex

fn add(&mut self, vector: Vector) -> Result<(), String>

Add a vector to the index

fn delete(&mut self, id: u64) -> Result<(), String>

Remove a vector from the index by ID

fn search( &self, query: &[f64], k: usize, similarity_metric: SimilarityMetric, ) -> Vec<SearchResult>

Search for the k most similar vectors

fn len(&self) -> usize

Get the number of vectors in the index

fn is_empty(&self) -> bool

Check if the index is empty

fn get_vector(&self, id: u64) -> Option<&Vector>

Get a vector by its ID

fn dimension(&self) -> usize

Get the dimension of vectors in this index