score-set 2.1.0

A Rust library for building static weighted scoring operator sets
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

use witnessed::Witnessed;

/// Witness attached to values known to be valid for the normalized `[0, 1]`
/// scoring boundary.
pub struct V01;

/// Error returned when a value cannot be proven to be in the normalized
/// `[0, 1]` range.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct V01Error;

/// Proves that an `f32` value is in the normalized `[0, 1]` range.
///
/// This function is suitable for use with [`witnessed::Witnessing::by`]:
///
/// ```
/// use score_set::traits::{prove_v01_f32, V01};
/// use witnessed::{WitnessExt, Witnessed};
///
/// let score: Witnessed<f32, V01> = 0.75_f32.witness().by(prove_v01_f32).unwrap();
/// assert_eq!(*score, 0.75);
/// ```
///
/// Values such as `NaN` are rejected because neither range comparison
/// succeeds for them.
pub fn prove_v01_f32(value: &f32) -> Result<V01, V01Error> {
    (0.0..=1.0).contains(value).then_some(V01).ok_or(V01Error)
}

/// Proves that an `f64` value is in the normalized `[0, 1]` range.
///
/// Values such as `NaN` are rejected because neither range comparison
/// succeeds for them.
pub fn prove_v01_f64(value: &f64) -> Result<V01, V01Error> {
    (0.0..=1.0).contains(value).then_some(V01).ok_or(V01Error)
}

/// Measures a context and returns a value chosen by the implementation.
///
/// `Output` is the value consumed by a corresponding `Map01F32` or `Map01F64`
/// implementation.
pub trait Measure<Ctx: ?Sized>: Send + Sync {
    /// The value produced by [`Measure::measure`].
    type Output;

    /// Extracts a measurable value from `ctx`.
    fn measure(&self, ctx: &Ctx) -> Self::Output;
}

/// Maps a measurement into the `[0, 1]` range.
///
/// `Input` is associated with the mapper rather than fixed in the trait, so a
/// mapper can consume any measurement type. The normalized result carries the
/// [`V01`] witness.
pub trait Map01F32: Send + Sync {
    /// The value accepted by [`Map01F32::map`].
    type Input;

    /// Converts `value` into a normalized score.
    fn map(&self, value: Self::Input) -> Witnessed<f32, V01>;
}

/// Maps a measurement into the `[0, 1]` range.
///
/// `Input` is associated with the mapper rather than fixed in the trait, so a
/// mapper can consume any measurement type. The normalized result carries the
/// [`V01`] witness.
pub trait Map01F64: Send + Sync {
    /// The value accepted by [`Map01F64::map`].
    type Input;

    /// Converts `value` into a normalized score.
    fn map(&self, value: Self::Input) -> Witnessed<f64, V01>;
}

/// Evaluates a context into an `f64` score.
pub trait EvalF64<Ctx: ?Sized>: Send + Sync {
    /// Computes a score from `ctx`.
    fn eval(&self, ctx: &Ctx) -> f64;
}

/// Evaluates a context into an `f32` score.
pub trait EvalF32<Ctx: ?Sized>: Send + Sync {
    /// Computes a score from `ctx`.
    fn eval(&self, ctx: &Ctx) -> f32;
}