precinct 0.2.0

Approximate nearest-neighbor search over region embeddings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

//! Approximate nearest-neighbor search over region embeddings (boxes, balls).
//!
//! Point-based ANN indices (HNSW, IVF, Vamana) assume queries and database
//! entries are single vectors. Region embeddings -- axis-aligned boxes, balls,
//! cones -- represent concepts as *volumes* in embedding space. precinct bridges
//! this gap.
//!
//! # Core abstractions
//!
//! - [`Region`] -- trait for geometric regions with center, point-to-region
//!   distance, and containment.
//! - [`AxisBox`], [`Ball`] -- concrete region types.
//! - [`RegionIndex`] -- ANN index over regions. Builds a point index over
//!   region centers, retrieves candidates, reranks with true region distance.
//!
//! # Usage
//!
//! ```
//! use precinct::{AxisBox, Region};
//!
//! let b = AxisBox::new(vec![0.0, 0.0], vec![1.0, 1.0]);
//! assert!(b.contains(&[0.5, 0.5]));
//! assert!(!b.contains(&[1.5, 0.5]));
//! assert_eq!(b.distance_to_point(&[0.5, 0.5]), 0.0);
//! ```

mod region;
pub use region::{AxisBox, Ball, Region};

mod distance;
pub use distance::{box_to_point_l2, ball_to_point_l2};

pub mod io;

#[cfg(feature = "index")]
pub mod index;
#[cfg(feature = "index")]
pub use index::{Error, IndexParams, RegionIndex, SearchParams};