Struct RoaringPostingList 

pub struct RoaringPostingList {
    pub doc_ids: RoaringBitmap,
    pub term_freqs: Vec<(u32, u32)>,
    pub default_tf: u32,
    pub max_tf: u32,
    pub blocks: Vec<RoaringBlockInfo>,
    pub max_score: f32,
}

Roaring bitmap with term frequencies for posting lists

Fields

doc_ids: RoaringBitmap

Document IDs as roaring bitmap

term_freqs: Vec<(u32, u32)>

Term frequencies (sparse map for non-1 frequencies) Most terms have tf=1, so we only store exceptions

default_tf: u32

Default term frequency (usually 1)

max_tf: u32

Maximum term frequency

blocks: Vec<RoaringBlockInfo>

Block metadata for BlockMax WAND (one per container)

max_score: f32

Global maximum score across all blocks

Implementations

impl RoaringPostingList

pub fn compute_bm25_upper_bound(max_tf: u32, idf: f32) -> f32

Compute BM25 upper bound score for a given max_tf and IDF

pub fn from_postings(doc_ids: &[u32], term_freqs: &[u32]) -> Self

Create from doc_ids and term frequencies (without IDF - for backwards compatibility)

pub fn from_postings_with_idf( doc_ids: &[u32], term_freqs: &[u32], idf: f32, ) -> Self

Create from doc_ids and term frequencies with IDF for block-max scores

pub fn get_tf(&self, doc_id: u32) -> u32

Get term frequency for a document

pub fn len(&self) -> u32

Number of documents

pub fn is_empty(&self) -> bool

Check if empty

pub fn num_blocks(&self) -> usize

Get number of blocks (containers)

pub fn block_for_doc(&self, doc_id: u32) -> Option<usize>

Get block index for a doc_id

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

Serialize

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

Deserialize

pub fn iterator(&self) -> RoaringPostingIterator<'_>

Create iterator

Trait Implementations

impl Clone for RoaringPostingList

fn clone(&self) -> RoaringPostingList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoaringPostingList

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

Formats the value using the given formatter.