Struct RecallReport 

#[non_exhaustive]
pub struct RecallReport {
    pub k: usize,
    pub per_query: Vec<PerQueryScore>,
}

Per-query trace plus aggregate metrics computed across the scored sample slice.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

k: usize

Top-K window used for every per-query metric.

per_query: Vec<PerQueryScore>

One PerQueryScore per input sample, in input order.

Implementations

impl RecallReport

pub fn hit_rate(&self) -> f64

Fraction of queries where any expected id appeared in the top-K. 0.0 when there are no queries.

pub fn mean_reciprocal_rank(&self) -> f64

Mean of 1 / rank of the first expected hit across all queries. Non-hits contribute 0. 0.0 when there are no queries.

pub fn mean_precision_at_k(&self) -> f64

Mean precision@K across all queries. 0.0 when there are no queries.

pub fn mean_recall_at_k(&self) -> f64

Mean recall@K across queries with at least one expected id. Queries with empty expected are excluded from the denominator — recall is undefined when there is nothing to retrieve. 0.0 when no query qualifies.

pub fn mean_ndcg_at_k(&self) -> f64

Mean NDCG@K across queries with at least one expected id. Same skip rule as Self::mean_recall_at_k — NDCG is undefined when ideal DCG is zero. 0.0 when no query qualifies.

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.

impl Serialize for RecallReport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.