Skip to main content

MaxSim

Struct MaxSim 

Source
pub struct MaxSim<'a> { /* private fields */ }
Expand description

Computes per-query-vector maximum similarities to document vectors.

For each query vector qᵢ, finds the maximum similarity (minimum negated inner product) to any document vector:

scores[i] = minⱼ -IP(qᵢ, dⱼ)

Implements DistanceFnMut for various matrix types (e.g., MatRef<Standard<f32>>).

§Usage

  • Create with MaxSim::new, providing a mutable scores buffer.
  • Call DistanceFnMut::evaluate with query and document matrices.
  • Read results from the scores buffer.

Implementations§

Source§

impl<'a> MaxSim<'a>

Source

pub fn new(scores: &'a mut [f32]) -> Result<Self, MaxSimError>

Creates a new MaxSim with the provided scores buffer.

§Errors

Returns an error if scores is empty.

Source

pub fn size(&self) -> usize

Returns the number of score slots in the buffer.

Source

pub fn get(&self, i: usize) -> Result<f32, MaxSimError>

Returns the score at index i.

Source

pub fn set(&mut self, i: usize, x: f32) -> Result<(), MaxSimError>

Sets the score at index i.

Source

pub fn scores_mut(&mut self) -> &mut [f32]

Returns a mutable reference to the internal buffer of scores.

This is useful for implementations external to crate as well as optimized implementations to access the buffer if needed.

Trait Implementations§

Source§

impl<'a> Debug for MaxSim<'a>

Source§

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

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

impl<const NBITS: usize> DistanceFunctionMut<QueryMatRef<'_, MinMaxMeta<NBITS>>, MatRef<'_, MinMaxMeta<NBITS>>> for MaxSim<'_>

Source§

fn evaluate( &mut self, query: QueryMatRef<'_, MinMaxMeta<NBITS>>, doc: MatRef<'_, MinMaxMeta<NBITS>>, )

Compute distances between the left and right arguments.
Source§

impl<T: Copy> DistanceFunctionMut<QueryMatRef<'_, Standard<T>>, MatRef<'_, Standard<T>>, Result<(), MaxSimError>> for MaxSim<'_>
where InnerProduct: for<'a, 'b> PureDistanceFunction<&'a [T], &'b [T], f32>,

Source§

fn evaluate( &mut self, query: QueryMatRef<'_, Standard<T>>, doc: MatRef<'_, Standard<T>>, ) -> Result<(), MaxSimError>

Compute distances between the left and right arguments.

Auto Trait Implementations§

§

impl<'a> Freeze for MaxSim<'a>

§

impl<'a> RefUnwindSafe for MaxSim<'a>

§

impl<'a> Send for MaxSim<'a>

§

impl<'a> Sync for MaxSim<'a>

§

impl<'a> Unpin for MaxSim<'a>

§

impl<'a> UnsafeUnpin for MaxSim<'a>

§

impl<'a> !UnwindSafe for MaxSim<'a>

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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> AsyncFriendly for T
where T: Send + Sync + 'static,