Skip to main content

RrfConfig

Struct RrfConfig 

Source
pub struct RrfConfig {
    pub k: u32,
    pub top_k: Option<usize>,
}
Expand description

RRF configuration.

§Example

use rankops::RrfConfig;

let config = RrfConfig::default()
    .with_k(60)
    .with_top_k(10);

Fields§

§k: u32

Smoothing constant (default: 60).

Must be >= 1 to avoid division by zero in the RRF formula. Values < 1 will cause panics during fusion.

§top_k: Option<usize>

Maximum results to return (None = all).

Implementations§

Source§

impl RrfConfig

Source

pub fn new(k: u32) -> Self

Create config with custom k.

§Panics

Panics if k == 0 (would cause division by zero in RRF formula).

§Example
use rankops::RrfConfig;

let config = RrfConfig::new(60);
Source

pub fn with_k(self, k: u32) -> Self

Set the k parameter (smoothing constant).

  • k=60 — Standard RRF, works well for most cases
  • k=1 — Top positions dominate heavily
  • k=100+ — More uniform contribution across ranks
§Panics

Panics if k == 0 (would cause division by zero in RRF formula).

Source

pub const fn with_top_k(self, top_k: usize) -> Self

Limit output to top_k results.

Trait Implementations§

Source§

impl Clone for RrfConfig

Source§

fn clone(&self) -> RrfConfig

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 Debug for RrfConfig

Source§

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

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

impl Default for RrfConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for RrfConfig

Source§

fn eq(&self, other: &RrfConfig) -> 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 Copy for RrfConfig

Source§

impl Eq for RrfConfig

Source§

impl StructuralPartialEq for RrfConfig

Auto Trait Implementations§

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.