uncertain-rs 0.2.0

A Rust library for uncertainty-aware programming, implementing the approach from 'Uncertain<T>: A First-Order Type for Uncertain Data'
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
use crate::traits::Shareable;
use crate::{Uncertain, computation::ComputationNode};
use std::ops::{Add, Div, Mul, Neg, Sub};

/// Trait alias for types that support arithmetic operations
pub trait Arithmetic:
    Add<Output = Self>
    + Sub<Output = Self>
    + Mul<Output = Self>
    + Div<Output = Self>
    + Clone
    + Send
    + Sync
    + 'static
{
    /// Returns the additive identity (zero)
    fn zero() -> Self;

    /// Returns the multiplicative identity (one)
    fn one() -> Self;
}

// No blanket implementation to avoid conflicts with specific implementations

// Implement Arithmetic for common numeric types
impl Arithmetic for f64 {
    fn zero() -> Self {
        0.0
    }

    fn one() -> Self {
        1.0
    }
}

impl Arithmetic for f32 {
    fn zero() -> Self {
        0.0
    }

    fn one() -> Self {
        1.0
    }
}

impl Arithmetic for i32 {
    fn zero() -> Self {
        0
    }

    fn one() -> Self {
        1
    }
}

impl Arithmetic for i64 {
    fn zero() -> Self {
        0
    }

    fn one() -> Self {
        1
    }
}

impl Arithmetic for u32 {
    fn zero() -> Self {
        0
    }

    fn one() -> Self {
        1
    }
}

impl Arithmetic for u64 {
    fn zero() -> Self {
        0
    }

    fn one() -> Self {
        1
    }
}

/// Binary operation types for computation graph
#[derive(Clone, Hash, PartialEq, Eq)]
pub enum BinaryOperation {
    Add,
    Sub,
    Mul,
    Div,
}

impl BinaryOperation {
    #[must_use]
    pub fn apply<T>(&self, left: T, right: T) -> T
    where
        T: Arithmetic,
    {
        match self {
            BinaryOperation::Add => left + right,
            BinaryOperation::Sub => left - right,
            BinaryOperation::Mul => left * right,
            BinaryOperation::Div => left / right,
        }
    }
}

// Addition operations
impl<T> Add for Uncertain<T>
where
    T: Arithmetic,
{
    type Output = Uncertain<T>;

    fn add(self, rhs: Self) -> Self::Output {
        let node = ComputationNode::BinaryOp {
            left: Box::new(self.node),
            right: Box::new(rhs.node),
            operation: BinaryOperation::Add,
        };
        Uncertain::with_node(node)
    }
}

impl<T> Add<T> for Uncertain<T>
where
    T: Arithmetic,
{
    type Output = Uncertain<T>;

    fn add(self, rhs: T) -> Self::Output {
        self + Uncertain::point(rhs)
    }
}

impl Add<Uncertain<f64>> for f64 {
    type Output = Uncertain<f64>;

    fn add(self, rhs: Uncertain<f64>) -> Self::Output {
        Uncertain::point(self) + rhs
    }
}

// Subtraction operations
impl<T> Sub for Uncertain<T>
where
    T: Arithmetic,
{
    type Output = Uncertain<T>;

    fn sub(self, rhs: Self) -> Self::Output {
        let node = ComputationNode::BinaryOp {
            left: Box::new(self.node),
            right: Box::new(rhs.node),
            operation: BinaryOperation::Sub,
        };
        Uncertain::with_node(node)
    }
}

impl<T> Sub<T> for Uncertain<T>
where
    T: Arithmetic,
{
    type Output = Uncertain<T>;

    fn sub(self, rhs: T) -> Self::Output {
        self - Uncertain::point(rhs)
    }
}

impl Sub<Uncertain<f64>> for f64 {
    type Output = Uncertain<f64>;

    fn sub(self, rhs: Uncertain<f64>) -> Self::Output {
        Uncertain::point(self) - rhs
    }
}

// Multiplication operations
impl<T> Mul for Uncertain<T>
where
    T: Arithmetic,
{
    type Output = Uncertain<T>;

    fn mul(self, rhs: Self) -> Self::Output {
        let node = ComputationNode::BinaryOp {
            left: Box::new(self.node),
            right: Box::new(rhs.node),
            operation: BinaryOperation::Mul,
        };
        Uncertain::with_node(node)
    }
}

impl<T> Mul<T> for Uncertain<T>
where
    T: Arithmetic,
{
    type Output = Uncertain<T>;

    fn mul(self, rhs: T) -> Self::Output {
        self * Uncertain::point(rhs)
    }
}

impl Mul<Uncertain<f64>> for f64 {
    type Output = Uncertain<f64>;

    fn mul(self, rhs: Uncertain<f64>) -> Self::Output {
        Uncertain::point(self) * rhs
    }
}

// Division operations
impl<T> Div for Uncertain<T>
where
    T: Arithmetic,
{
    type Output = Uncertain<T>;

    fn div(self, rhs: Self) -> Self::Output {
        let node = ComputationNode::BinaryOp {
            left: Box::new(self.node),
            right: Box::new(rhs.node),
            operation: BinaryOperation::Div,
        };
        Uncertain::with_node(node)
    }
}

impl<T> Div<T> for Uncertain<T>
where
    T: Arithmetic,
{
    type Output = Uncertain<T>;

    fn div(self, rhs: T) -> Self::Output {
        self / Uncertain::point(rhs)
    }
}

impl Div<Uncertain<f64>> for f64 {
    type Output = Uncertain<f64>;

    fn div(self, rhs: Uncertain<f64>) -> Self::Output {
        Uncertain::point(self) / rhs
    }
}

// Negation
impl<T> Neg for Uncertain<T>
where
    T: Neg<Output = T> + Shareable,
{
    type Output = Uncertain<T>;

    fn neg(self) -> Self::Output {
        self.map(|x| -x)
    }
}

// Additional mathematical operations for floating point types
impl Uncertain<f64> {
    /// Raises the uncertain value to a power
    ///
    /// # Example
    /// ```rust
    /// use uncertain_rs::Uncertain;
    ///
    /// let base = Uncertain::normal(2.0, 0.1);
    /// let squared = base.pow(2.0);
    /// ```
    #[must_use]
    pub fn pow(&self, exponent: f64) -> Uncertain<f64> {
        self.map(move |x| x.powf(exponent))
    }

    /// Takes the square root of the uncertain value
    ///
    /// # Example
    /// ```rust
    /// use uncertain_rs::Uncertain;
    ///
    /// let positive = Uncertain::uniform(1.0, 100.0);
    /// let sqrt_val = positive.sqrt();
    /// ```
    #[must_use]
    pub fn sqrt(&self) -> Uncertain<f64> {
        self.map(f64::sqrt)
    }

    /// Takes the natural logarithm of the uncertain value
    ///
    /// # Example
    /// ```rust
    /// use uncertain_rs::Uncertain;
    ///
    /// let positive = Uncertain::uniform(0.1, 10.0);
    /// let ln_val = positive.ln();
    /// ```
    #[must_use]
    pub fn ln(&self) -> Uncertain<f64> {
        self.map(f64::ln)
    }

    /// Takes the exponential of the uncertain value
    ///
    /// # Example
    /// ```rust
    /// use uncertain_rs::Uncertain;
    ///
    /// let normal = Uncertain::normal(0.0, 1.0);
    /// let exp_val = normal.exp();
    /// ```
    #[must_use]
    pub fn exp(&self) -> Uncertain<f64> {
        self.map(f64::exp)
    }

    /// Takes the absolute value of the uncertain value
    ///
    /// # Example
    /// ```rust
    /// use uncertain_rs::Uncertain;
    ///
    /// let normal = Uncertain::normal(0.0, 2.0);
    /// let abs_val = normal.abs();
    /// ```
    #[must_use]
    pub fn abs(&self) -> Uncertain<f64> {
        self.map(f64::abs)
    }

    /// Applies sine function to the uncertain value
    #[must_use]
    pub fn sin(&self) -> Uncertain<f64> {
        self.map(f64::sin)
    }

    /// Applies cosine function to the uncertain value
    #[must_use]
    pub fn cos(&self) -> Uncertain<f64> {
        self.map(f64::cos)
    }

    /// Applies tangent function to the uncertain value
    #[must_use]
    pub fn tan(&self) -> Uncertain<f64> {
        self.map(f64::tan)
    }
}

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

    #[test]
    fn test_addition() {
        let x = Uncertain::point(5.0);
        let y = Uncertain::point(3.0);
        let sum = x + y;
        assert!((sum.sample() - 8.0_f64).abs() < f64::EPSILON);
    }

    #[test]
    fn test_scalar_addition() {
        let x = Uncertain::point(5.0);
        let sum = x + 3.0;
        assert!((sum.sample() - 8.0_f64).abs() < f64::EPSILON);

        let sum2 = 3.0 + Uncertain::point(5.0);
        assert!((sum2.sample() - 8.0_f64).abs() < f64::EPSILON);
    }

    #[test]
    fn test_multiplication() {
        let x = Uncertain::point(4.0);
        let y = Uncertain::point(3.0);
        let product = x * y;
        assert!((product.sample() - 12.0_f64).abs() < f64::EPSILON);
    }

    #[test]
    fn test_complex_expression() {
        let x = Uncertain::point(2.0);
        let y = Uncertain::point(3.0);
        let result = (x + y) * 2.0 - 1.0;
        assert!((result.sample() - 9.0_f64).abs() < f64::EPSILON); // (2 + 3) * 2 - 1 = 9
    }

    #[test]
    fn test_mathematical_functions() {
        let x = Uncertain::point(4.0);
        assert!((x.sqrt().sample() - 2.0_f64).abs() < f64::EPSILON);

        let y = Uncertain::point(2.0);
        assert!((y.pow(3.0).sample() - 8.0_f64).abs() < f64::EPSILON);
    }
}