Struct MatchResult 

pub struct MatchResult {
    pub is_match: bool,
    pub score: f32,
    pub votes: u32,
    pub prominence: f32,
    pub offset: TimeOffset,
    pub time_scale: f32,
}

Outcome of matching a query fingerprint against one reference.

MatchResult is always produced — even degenerate inputs yield MatchResult::NONE rather than an error. The is_match field tells whether the score cleared the matcher’s decision threshold.

Fields

is_match: bool

true iff the score cleared the configured decision threshold.

score: f32

Normalised confidence in [0.0, 1.0], algorithm-agnostic (higher = more likely the same recording).

votes: u32

Raw aligned-evidence count (landmark votes, aligned Haitsma frames, or RANSAC inlier count).

prominence: f32

Peak prominence: peak evidence divided by background floor.

High (≫ 1) → sharp spike, a true alignment. ~1 → flat histogram, random collisions. This is the primary false-positive guard.

Semantics differ by matcher

• Wang / Panako: peak_consolidated / (mean_rest + 1) on the offset or (scale, offset) histogram.
• Haitsma: BER-derived proxy, not comparable to Wang/Panako prominence. The matcher reports median_BER / (BER + ε); the index path reports 0.5 / BER.
• Neural: relative cosine excess over other lag positions (SlidingMax) or 1.0 (Centroid / DTW).

Do not threshold prominence with a single constant across matcher types.

offset: TimeOffset

Estimated alignment of the query within the reference.

time_scale: f32

Estimated time-scale: query_duration / reference_duration.

1.0 for algorithms with no tempo model (Wang, Haitsma, neural). Panako reports the reciprocal of the internal Hough/RANSAC scale s = ref_span / query_span (i.e. 1/s), clamped to [0.5, 2.0]. Note that PanakoMatchConfig::scale_min / PanakoMatchConfig::scale_max bound the internal search grid for s, not this public reciprocal.

Implementations

impl MatchResult

pub const NONE: MatchResult

Constant to return when no meaningful alignment exists.

Trait Implementations

impl Clone for MatchResult

fn clone(&self) -> MatchResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MatchResult

impl Debug for MatchResult

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

Formats the value using the given formatter.

impl PartialEq for MatchResult

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MatchResult