Struct CorpusStats 

pub struct CorpusStats { /* private fields */ }

Store-wide corpus statistics.

crate::fts::index::LexicalIndex derives these store-wide values from all of its sealed segments. Scoring never substitutes per-segment corpus statistics.

Implementations

impl CorpusStats

pub const fn new(doc_count: u64, total_tokens: u64) -> Result<Self, Bm25Error>

Builds validated statistics.

Errors

Returns Bm25Error::EmptyCorpus or Bm25Error::NoTokens when avgdl would be undefined. An empty corpus is not scored; it is refused, because a silent avgdl of zero produces infinities.

pub const fn document_count(&self) -> u64

Returns the store-wide document count, N.

pub const fn total_tokens(&self) -> u64

Returns the store-wide analyzed token count.

pub fn average_document_length(&self) -> f64

Returns avgdl, counted in tokens after analysis.

The unit matters: avgdl must be counted over the same unit being scored, in analyzed tokens, never in raw bytes or pre-analysis words.

Trait Implementations

impl Clone for CorpusStats

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CorpusStats

impl Debug for CorpusStats

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

Formats the value using the given formatter.

impl Eq for CorpusStats

impl PartialEq for CorpusStats

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CorpusStats