Skip to main content

BigramFilter

Struct BigramFilter 

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

Inverted bigram index with optional “skip-1” extension Copmressed into bitset for minimal usage, the layout of this struct actually matters

Implementations§

Source§

impl BigramFilter

Source

pub fn query(&self, pattern: &[u8]) -> Option<Vec<u64>>

AND the posting lists for all query bigrams (consecutive + skip). Returns None if no query bigrams are tracked.

Source

pub fn set_skip_index(&mut self, skip: BigramFilter)

Attach a skip-1 bigram index for tighter candidate filtering.

Source

pub fn is_candidate(candidates: &[u64], file_idx: usize) -> bool

Source

pub fn count_candidates(candidates: &[u64]) -> usize

Source

pub fn is_ready(&self) -> bool

Source

pub fn file_count(&self) -> usize

Source

pub fn columns_used(&self) -> usize

Source

pub fn heap_bytes(&self) -> usize

Total heap bytes used by this index (lookup + dense data + skip).

Source

pub fn has_key(&self, key: u16) -> bool

Check whether a bigram key is present in this index.

Source

pub fn lookup(&self) -> &[u16]

Raw lookup table (65536 entries mapping bigram key → column index).

Source

pub fn dense_data(&self) -> &[u64]

Flat dense bitset data at fixed stride words.

Source

pub fn words(&self) -> usize

Number of u64 words per column (= ceil(file_count / 64)).

Source

pub fn dense_count(&self) -> usize

Number of dense columns retained after compression.

Source

pub fn populated(&self) -> usize

Number of files that contributed content to the index.

Source

pub fn skip_index(&self) -> Option<&BigramFilter>

Reference to the optional skip-1 bigram sub-index.

Source

pub fn new( lookup: Vec<u16>, dense_data: Vec<u64>, dense_count: usize, words: usize, file_count: usize, populated: usize, ) -> Self

Create a new bigram filter from the internal data

Trait Implementations§

Source§

impl Debug for BigramFilter

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> 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, 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