pokerkit 1.1.0

Core type aliases, traits, and constants for robopoker
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

//! Axis-tagged scalar observation.

use std::marker::PhantomData;

use super::*;

/// A finite scalar observation tagged with its [`Axis`].
///
/// Named `Scalar` rather than `Observation` to avoid colliding with the
/// poker-domain `deuce::Observation`.
pub struct Scalar<A>
where
    A: Axis,
{
    value: f64,
    axis: PhantomData<A>,
}

impl<A> std::fmt::Debug for Scalar<A>
where
    A: Axis,
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Scalar").field("value", &self.value).finish()
    }
}

impl<A> Copy for Scalar<A> where A: Axis {}

impl<A> Clone for Scalar<A>
where
    A: Axis,
{
    fn clone(&self) -> Self {
        *self
    }
}

impl<A> Scalar<A>
where
    A: Axis,
{
    /// Construct a scalar. Panics if not finite — callers are expected
    /// to validate at the system boundary, not pass NaN/inf in.
    pub fn new(value: f64) -> Self {
        assert!(value.is_finite(), "Scalar must be finite, got {value}");
        Self {
            value,
            axis: PhantomData,
        }
    }

    /// Raw value.
    pub fn value(&self) -> f64 {
        self.value
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    struct T;
    impl Axis for T {}

    #[test]
    #[should_panic(expected = "Scalar must be finite")]
    fn rejects_nan() {
        let _ = Scalar::<T>::new(f64::NAN);
    }

    #[test]
    #[should_panic(expected = "Scalar must be finite")]
    fn rejects_infinity() {
        let _ = Scalar::<T>::new(f64::INFINITY);
    }
}