Skip to main content

FusedResult

Struct FusedResult 

Source
pub struct FusedResult<K> {
    pub id: K,
    pub score: f32,
    pub rank: usize,
    pub explanation: Explanation,
}
Expand description

A fused result with full provenance information for debugging and analysis.

Unlike the simple Vec<(DocId, f32)> returned by standard fusion functions, FusedResult preserves which retrievers contributed each document, their original ranks and scores, and how much each source contributed to the final score.

§Example

use rankops::explain::{rrf_explain, RetrieverId};

let bm25 = vec![("d1", 12.5), ("d2", 11.0)];
let dense = vec![("d2", 0.9), ("d3", 0.8)];

let retrievers = vec![
    RetrieverId::new("bm25"),
    RetrieverId::new("dense"),
];

let explained = rrf_explain(
    &[&bm25[..], &dense[..]],
    &retrievers,
    rankops::RrfConfig::default(),
);

// d2 appears in both lists, so it has 2 source contributions
let d2 = explained.iter().find(|r| r.id == "d2").unwrap();
assert_eq!(d2.explanation.sources.len(), 2);
assert_eq!(d2.explanation.consensus_score, 1.0); // 2/2 lists

Fields§

§id: K

Document identifier.

§score: f32

Final fused score.

§rank: usize

Final rank position (0-indexed, highest score = rank 0).

§explanation: Explanation

Explanation of how this score was computed.

Trait Implementations§

Source§

impl<K: Clone> Clone for FusedResult<K>

Source§

fn clone(&self) -> FusedResult<K>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K: Debug> Debug for FusedResult<K>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<K: PartialEq> PartialEq for FusedResult<K>

Source§

fn eq(&self, other: &FusedResult<K>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<K> StructuralPartialEq for FusedResult<K>

Auto Trait Implementations§

§

impl<K> Freeze for FusedResult<K>
where K: Freeze,

§

impl<K> RefUnwindSafe for FusedResult<K>
where K: RefUnwindSafe,

§

impl<K> Send for FusedResult<K>
where K: Send,

§

impl<K> Sync for FusedResult<K>
where K: Sync,

§

impl<K> Unpin for FusedResult<K>
where K: Unpin,

§

impl<K> UnsafeUnpin for FusedResult<K>
where K: UnsafeUnpin,

§

impl<K> UnwindSafe for FusedResult<K>
where K: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.