Struct AvgLenEstimate 

pub struct AvgLenEstimate {
    pub mean: f64,
    pub docs: usize,
}

Mean post-pipeline token count over sampled document texts — the estimator for a corpus-true avg_len.

“Real data” in one function: pass the actual field texts (e.g. from a SCROLL sample) and get the average doc_len the TF formula consumes, measured with the same pipeline that will embed the writes. Returns None when the sample holds no documents or no tokens at all (an empty corpus has no meaningful average — keep the default instead of dividing by zero or storing avg_len = 0, which validation rejects).

Fields

mean: f64

Mean post-pipeline tokens per document (> 0 when returned).

docs: usize

Documents measured.

Trait Implementations

impl Clone for AvgLenEstimate

fn clone(&self) -> AvgLenEstimate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AvgLenEstimate

impl Debug for AvgLenEstimate

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

Formats the value using the given formatter.

impl PartialEq for AvgLenEstimate

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AvgLenEstimate