HnswGraph

Struct HnswGraph 

Source
pub struct HnswGraph {
    pub nodes: HashMap<EntityId, HnswNode>,
    pub entry_point: Option<EntityId>,
    pub max_layer: usize,
    pub distance_metric: DistanceMetric,
    pub dimension: usize,
}
Expand description

The HNSW graph structure.

Fields§

§nodes: HashMap<EntityId, HnswNode>

All nodes in the graph, keyed by entity ID.

§entry_point: Option<EntityId>

The entry point node (highest level node).

§max_layer: usize

The current maximum layer in the graph.

§distance_metric: DistanceMetric

The distance metric used for similarity.

§dimension: usize

The dimension of embeddings in this graph.

Implementations§

Source§

impl HnswGraph

Source

pub fn new(dimension: usize, distance_metric: DistanceMetric) -> Self

Create a new empty HNSW graph.

Source

pub fn get_node(&self, entity_id: EntityId) -> Option<&HnswNode>

Get a node by entity ID.

Source

pub fn get_node_mut(&mut self, entity_id: EntityId) -> Option<&mut HnswNode>

Get a mutable node by entity ID.

Source

pub fn contains(&self, entity_id: EntityId) -> bool

Check if a node exists in the graph.

Source

pub fn len(&self) -> usize

Get the number of nodes in the graph.

Source

pub fn is_empty(&self) -> bool

Check if the graph is empty.

Source

pub fn distance(&self, a: &Embedding, b: &Embedding) -> f32

Calculate the distance between two embeddings.

Source

pub fn distance_to_node( &self, query: &Embedding, entity_id: EntityId, ) -> Option<f32>

Calculate the distance from a query to a node.

Source

pub fn insert_node(&mut self, node: HnswNode)

Insert a node into the graph.

Source

pub fn remove_node(&mut self, entity_id: EntityId) -> Option<HnswNode>

Remove a node from the graph.

Trait Implementations§

Source§

impl Debug for HnswGraph

Source§

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

Formats the value using the given formatter. 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> 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, 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<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