OneLevel

Struct OneLevel 

Source
pub struct OneLevel<T: Indexable> { /* private fields */ }
Expand description

A single-level PGM-Index.

This is a simpler variant of the multi-level index that uses only one level of segments. It’s suitable for smaller datasets or when you want to minimize memory usage at the cost of slightly longer segment search time.

§Example

use pgm_extra::index::external::OneLevel;

let keys: Vec<u64> = (0..1000).collect();
let index = OneLevel::new(&keys, 8).unwrap();

assert!(index.contains(&keys, &500));

Implementations§

Source§

impl<T: Indexable> OneLevel<T>
where T::Key: Ord,

Source

pub fn new(data: &[T], epsilon: usize) -> Result<Self, Error>

Build a new single-level PGM-Index from sorted data.

Source

pub fn search(&self, value: &T) -> ApproxPos

Get an approximate position for the given value.

Source

pub fn search_by_key(&self, key: &T::Key) -> ApproxPos

Get an approximate position for the given key.

Source

pub fn lower_bound(&self, data: &[T], value: &T) -> usize
where T: Ord,

Find the first position where data[pos] >= value.

Source

pub fn upper_bound(&self, data: &[T], value: &T) -> usize
where T: Ord,

Find the first position where data[pos] > value.

Source

pub fn contains(&self, data: &[T], value: &T) -> bool
where T: Ord,

Check if the value exists in the data.

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn segments_count(&self) -> usize

Source

pub fn epsilon(&self) -> usize

Source

pub fn size_in_bytes(&self) -> usize

Source

pub fn range_indices<R>(&self, data: &[T], range: R) -> (usize, usize)
where T: Ord, R: RangeBounds<T>,

Returns the (start, end) indices for iterating over data in the given range.

Source

pub fn range<'a, R>( &self, data: &'a [T], range: R, ) -> impl DoubleEndedIterator<Item = &'a T>
where T: Ord, R: RangeBounds<T>,

Returns an iterator over data in the given range.

Trait Implementations§

Source§

impl<T: Clone + Indexable> Clone for OneLevel<T>
where T::Key: Clone,

Source§

fn clone(&self) -> OneLevel<T>

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<T: Debug + Indexable> Debug for OneLevel<T>
where T::Key: Debug,

Source§

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

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

impl<'de, T: Indexable> Deserialize<'de> for OneLevel<T>

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<T: Indexable> External<T> for OneLevel<T>
where T::Key: Ord,

Source§

fn search(&self, value: &T) -> ApproxPos

Get an approximate position for the value.
Source§

fn lower_bound(&self, data: &[T], value: &T) -> usize
where T: Ord,

Find the first position where data[pos] >= value.
Source§

fn upper_bound(&self, data: &[T], value: &T) -> usize
where T: Ord,

Find the first position where data[pos] > value.
Source§

fn contains(&self, data: &[T], value: &T) -> bool
where T: Ord,

Check if the value exists in the sorted slice.
Source§

fn len(&self) -> usize

Number of elements the index was built for.
Source§

fn segments_count(&self) -> usize

Number of segments in the index.
Source§

fn epsilon(&self) -> usize

Epsilon value used for the bottom level.
Source§

fn size_in_bytes(&self) -> usize

Approximate memory usage in bytes.
Source§

fn is_empty(&self) -> bool

Whether the index is empty.
Source§

impl<T: Indexable> Serialize for OneLevel<T>

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§

§

impl<T> Freeze for OneLevel<T>

§

impl<T> RefUnwindSafe for OneLevel<T>
where <T as Indexable>::Key: RefUnwindSafe,

§

impl<T> Send for OneLevel<T>

§

impl<T> Sync for OneLevel<T>

§

impl<T> Unpin for OneLevel<T>
where <T as Indexable>::Key: Unpin,

§

impl<T> UnwindSafe for OneLevel<T>
where <T as Indexable>::Key: UnwindSafe,

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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>,