Struct RecallReport 

pub struct RecallReport {
    pub candidate_budget: usize,
    pub num_rows: usize,
    pub total_planted: usize,
    pub total_recovered: usize,
    pub recall: f64,
    pub avg_candidates_gathered: f64,
    pub num_atoms: usize,
    pub misses: Vec<RecallMiss>,
}

Result of SaeCandidateIndex::recall_report.

Fields

candidate_budget: usize

Candidate budget the recall was measured at.

num_rows: usize

Number of rows evaluated.

total_planted: usize

Total planted truly-active atoms across all rows.

total_recovered: usize

How many of them appeared in the proposed sets.

recall: f64

recall@candidate_budget = recovered / planted (1.0 if nothing planted).

avg_candidates_gathered: f64

Mean number of candidates the sublinear gather returned per row — the sublinearity witness; compare against num_atoms.

num_atoms: usize

Total atoms in the index (for the sublinearity ratio).

misses: Vec<RecallMiss>

Every miss, with its row, atom, alignment, and reason. No silent drops.

Implementations

impl RecallReport

pub fn sublinearity_ratio(&self) -> f64

Convenience: ratio of mean gathered candidates to dictionary size. A value far below 1.0 is the evidence that proposal touched a sublinear slice of the dictionary.

Trait Implementations

impl Clone for RecallReport

fn clone(&self) -> RecallReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecallReport

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

Formats the value using the given formatter.