Struct SparseSkipEntry 

pub struct SparseSkipEntry {
    pub first_doc: DocId,
    pub last_doc: DocId,
    pub offset: u32,
    pub max_weight: f32,
}

Skip entry for sparse posting lists with block-max support

Extends the basic skip entry with max_weight for Block-Max WAND optimization.

Fields

first_doc: DocId

First doc_id in the block (absolute)

last_doc: DocId

Last doc_id in the block

offset: u32

Byte offset to block data

max_weight: f32

Maximum weight in this block (for Block-Max optimization)

Implementations

impl SparseSkipEntry

pub fn new( first_doc: DocId, last_doc: DocId, offset: u32, max_weight: f32, ) -> Self

pub fn block_max_contribution(&self, query_weight: f32) -> f32

Compute the maximum possible contribution of this block to a dot product

For a query dimension with weight query_weight, the maximum contribution from this block is query_weight * max_weight.

pub fn write<W: Write>(&self, writer: &mut W) -> Result<()>

Write skip entry to writer

pub fn read<R: Read>(reader: &mut R) -> Result<Self>

Read skip entry from reader

Trait Implementations

impl Clone for SparseSkipEntry

fn clone(&self) -> SparseSkipEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SparseSkipEntry

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

Formats the value using the given formatter.

impl PartialEq for SparseSkipEntry

fn eq(&self, other: &SparseSkipEntry) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SparseSkipEntry

impl StructuralPartialEq for SparseSkipEntry