Struct RecallReport 

pub struct RecallReport {
    pub k: usize,
    pub query_count: usize,
    pub mean_recall: f64,
    pub min_recall: f64,
    pub max_recall: f64,
}

Summary of a recall@k measurement against a known or computed ground-truth set.

mean_recall, min_recall, and max_recall are aggregated across the query set; each per-query recall is |retrieved_topk ∩ true_topk| / k and lies in [0.0, 1.0]. Per-query values are not retained because they grow O(n_queries) and the use cases at this version only need the summary.

Examples

use iqdb_eval::RecallReport;

let r = RecallReport {
    k: 10,
    query_count: 100,
    mean_recall: 0.97,
    min_recall: 0.80,
    max_recall: 1.00,
};
assert!(r.min_recall <= r.mean_recall && r.mean_recall <= r.max_recall);

Fields

k: usize

The k used for the top-k queries that produced this report.

query_count: usize

The number of queries the report was aggregated over.

mean_recall: f64

Arithmetic mean of per-query recall across the query set.

min_recall: f64

Smallest per-query recall observed in the query set.

max_recall: f64

Largest per-query recall observed in the query set.

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<'de> Deserialize<'de> for RecallReport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RecallReport

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for RecallReport