Struct Scorer 

pub struct Scorer { /* private fields */ }

A reusable scorer with a fixed Prefer setting.

Construct once and call Scorer::score / Scorer::score_positions for each candidate. All three algorithms share the same Gotoh DP core; only the gap-penalty constants differ.

The free functions score and score_positions are thin wrappers around Scorer::default() (i.e. Prefer::Contiguous).

Examples

use neek_core::{Scorer, config::Prefer};

// Prefer matches that start early in each candidate.
let scorer = Scorer::new(Prefer::Prefix);
assert!(scorer.score(b"bl", b"build") > scorer.score(b"bl", b"table"));

// Prefer matches that end late in each candidate.
let scorer = Scorer::new(Prefer::Suffix);
assert!(scorer.score(b"le", b"cable") > scorer.score(b"le", b"label"));

Implementations

impl Scorer

pub fn new(prefer: Prefer) -> Self

Create a new scorer with the given preference.

pub fn prefer(self) -> Prefer

Return this scorer’s Prefer setting.

pub fn score(self, needle: &[u8], haystack: &[u8]) -> Score

Compute the fuzzy match score of needle against haystack using this scorer’s preference.

Returns SCORE_MAX for an exact (case-insensitive) match, SCORE_MIN when there is no match or the inputs are out of range, and a finite score otherwise.

pub fn score_positions( self, needle: &[u8], haystack: &[u8], positions: &mut [usize], ) -> Score

Compute the fuzzy match score and fill positions with the haystack indices of the matched needle characters.

positions must have length >= needle.len(). On return, positions[i] is the haystack index of the character matched to needle[i], in strictly increasing order.

Returns the same score as Scorer::score would for the same inputs.

Allocation

Allocates two Vec<MaybeUninit<f64>> of size needle.len() × MATCH_MAX_LEN for the full DP matrices required by backtracking.

Trait Implementations

impl Clone for Scorer

fn clone(&self) -> Scorer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scorer

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

Formats the value using the given formatter.

impl Default for Scorer

fn default() -> Scorer

Returns the “default value” for a type.

impl PartialEq for Scorer

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

impl Eq for Scorer

impl StructuralPartialEq for Scorer