LearnedSparseIndex

Struct LearnedSparseIndex 

Source
pub struct LearnedSparseIndex { /* private fields */ }
Expand description

Learned Sparse Index using linear regression

Now with key normalization for numerical stability with large u64 keys. Keys are normalized to [0, n-1] before regression, avoiding precision loss with values near u64::MAX.

Implementations§

Source§

impl LearnedSparseIndex

Source

pub fn empty() -> Self

Create an empty index

Source

pub fn build(keys: &[u64]) -> Self

Build index from sorted keys

Keys MUST be sorted in ascending order. This is not validated for performance.

Source

pub fn build_with_threshold(keys: &[u64], correction_threshold: usize) -> Self

Build index with custom correction threshold

Lower threshold = more corrections stored = faster lookups but more memory Higher threshold = fewer corrections = slower lookups but less memory

Source

pub fn lookup(&self, key: u64) -> LookupResult

Lookup: O(1) expected, O(ε) worst case

Source

pub fn lookup_with_error(&self, key: u64, max_error: usize) -> LookupResult

Lookup with a custom error margin (tighter range if you know data is regular)

Source

pub fn stats(&self) -> LearnedIndexStats

Get index statistics

Source

pub fn is_efficient(&self) -> bool

Returns true if this index is well-suited for learned indexing (low error, few corrections)

Source

pub fn memory_bytes(&self) -> usize

Memory usage in bytes

Source

pub fn insert(&mut self, key: u64, position: usize, keys: &[u64]) -> bool

Incrementally add a key (rebuilds if model quality degrades) Returns true if a rebuild was triggered

Trait Implementations§

Source§

impl Clone for LearnedSparseIndex

Source§

fn clone(&self) -> LearnedSparseIndex

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LearnedSparseIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for LearnedSparseIndex

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for LearnedSparseIndex

Source§

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

Serialize this value into the given Serde serializer. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,