sprk 0.1.0

#![warn(missing_docs)]

//! A high-performance spatial index for radius queries in D-dimensional Euclidean space.
//!
//! The core data structure is [`Sprk`], which combines KD-tree-like axis-aligned
//! partitioning with SIMD-vectorized leaf scans and lookup-table-based pruning.
//! For cases where the dimensionality is not known at compile time, [`DynSprk`]
//! provides the same functionality with a runtime dimension parameter.
//!
//! # Quick Start
//!
//! ```
//! use sprk::Sprk;
//!
//! let positions = vec![[0.0f32, 0.0], [1.0, 0.0], [0.0, 1.0], [5.0, 5.0]];
//! let tree: Sprk<2> = Sprk::new(&positions);
//!
//! let mut results: Vec<u32> = Vec::new();
//! tree.query_radius(&[0.5, 0.5], 1.5, &mut results);
//! assert_eq!(results.len(), 3); // indices 0, 1, 2
//! ```
//!
//! # Output Types
//!
//! The output type is controlled by the [`QueryOutput`] trait.
//! Use integer types (`u32`, `usize`) for index-only results, or [`IdDist`] for
//! (index, squared distance) pairs:
//!
//! ```
//! use sprk::{Sprk, IdDist};
//!
//! let tree: Sprk<2> = Sprk::new(&[[0.0f32, 0.0], [1.0, 0.0]]);
//! let mut pairs: Vec<IdDist<u32, f32>> = Vec::new();
//! tree.query_radius(&[0.0, 0.0], 2.0, &mut pairs);
//! for p in &pairs {
//!     println!("index {}, squared distance {}", p.id, p.dist);
//! }
//! ```

#[cfg(feature = "internals")]
#[allow(missing_docs)]
pub mod dynamic;
#[cfg(not(feature = "internals"))]
pub(crate) mod dynamic;

/// Result types and the [`QueryOutput`] trait that controls what `query_radius` produces.
pub mod output;

#[cfg(feature = "internals")]
#[allow(missing_docs)]
pub mod scalar;
#[cfg(not(feature = "internals"))]
pub(crate) mod scalar;

#[cfg(feature = "internals")]
#[allow(missing_docs)]
pub mod simd;
#[cfg(not(feature = "internals"))]
pub(crate) mod simd;

#[cfg(feature = "internals")]
#[allow(missing_docs)]
pub mod svd;
#[cfg(not(feature = "internals"))]
pub(crate) mod svd;

mod iter;
mod query;
mod tree;
mod vec_writer;

pub use dynamic::DynSprk;
pub use output::{IdDist, QueryOutput};
pub use scalar::{IdStorage, Scalar};
pub use tree::Sprk;