tolerance 1.2.0

Math representation of the physically needed permissible deviation of measures.
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

use crate::{error::ToleranceError, Myth16, Myth64, Unit};
#[cfg(feature = "serde")]
use serde::{de::Visitor, Deserialize, Deserializer, Serialize};
use std::convert::TryFrom;
use std::fmt::{Debug, Display, Formatter};
use std::ops::{Add, AddAssign, Div, Mul, Neg, Sub, SubAssign};
use std::str::FromStr;

///
/// # 32bit measurement type
///
/// A type to calculate lossless dimensions with a fixed 4 digit precision.
///
/// All sizes are defined in the tenth fraction of `μ`:
///
///  * `10` = 1 μ
///  * `10_000`  = 1 mm
///  * `10_000_000`  = 1 m
///
/// The standard `Display::fmt`-method represents the value in `mm`. The *alternate* Display
/// shows the `i32` value.
///
/// As `10_000` = 1 mm
///
/// ### Warning
/// Casting an `i64` into a `Myth32` can cause an `IntegerOverflow`-error similar to casting
/// a big `i64`-value into an `i32`. It's up to the programmer to omit these situation.
///
/// ⚠ **Don't try to store more then `+/- 214 meter` in a** `Myth32`.
///
/// ### Example:
/// ```rust
///#    use tolerance::Myth32;
///     let myth = Myth32::from(12.5);
///
///     assert_eq!(format!("{myth}"),"12.5");
///     assert_eq!(format!("{myth:.2}"), "12.50");
///     assert_eq!(format!("{myth:.4}"),"12.5000");
///     assert_eq!(format!("{myth:#}"), "125000");
/// ```
///

#[cfg_attr(feature = "serde", derive(Serialize))]
#[derive(Clone, Copy, PartialEq, Eq, Hash, Default, PartialOrd, Ord)]
#[must_use]
pub struct Myth32(pub(crate) i32);

impl Myth32 {
    #[must_use]
    pub const fn as_i32(&self) -> i32 {
        self.0
    }
}

super::standard_myths!(Myth32, i32, u64, u32, u16, u8, usize, i64, i32, i16, i8, isize);
super::from_number!(Myth32, u16, u8, i32, i16, i8);
super::try_from_number!(Myth32, u64, u32, i64, isize, usize);
super::from_myths!(Myth32, Myth16);
super::try_from_myths!(Myth32, Myth64);
super::calc_with_myths!(Myth32, i32, Myth32, Myth16);
#[cfg(feature = "serde")]
super::de_serde!(Myth32, i32);

#[cfg(test)]
mod should {
    use super::{Myth32, Unit};
    use pretty_assertions::assert_eq;

    #[test]
    fn try_from_str() {
        let d = Myth32::try_from("12345.12343").unwrap();
        assert_eq!(d, Myth32(123_451_234));
        let d = Myth32::try_from("6.02").unwrap();
        assert_eq!(d, Myth32(60_200));

        let d = Myth32::try_from(" +2.07").unwrap();
        assert_eq!(d, Myth32(20_700));
        let d = Myth32::try_from("-3.01").unwrap();
        assert_eq!(d, Myth32(-30_100));
    }

    #[test]
    fn neg() {
        let m = -Myth32(232_332);
        let n = Myth32(-232_332);
        assert_eq!(n.0, m.0);
        assert_eq!(n, m);
    }

    #[test]
    fn round() {
        let m = Myth32(1_234_567);
        assert_eq!(Myth32(1_234_570), m.round(Unit::MY));
        assert_eq!(Myth32(1_200_000), m.round(Unit::CM));
        assert_eq!(Myth32(10_000_000), Myth32(9_999_000).round(Unit::MM));
        assert_eq!(Myth32(0), Myth32::from(-0.4993).round(Unit::MM));
        assert_eq!(Myth32(-4990), Myth32::from(-0.4993).round(Unit::MY));
        assert_eq!(Myth32(-10000), Myth32::from(-5000).round(Unit::MM));
        let m = Myth32::from(340.993);
        assert_eq!(10, *Unit::potency(1));
        assert_eq!(Myth32(3_409_930), m.round(Unit::potency(1)));
        assert_eq!(100, *Unit::potency(2));
        assert_eq!(Myth32(3_409_900), m.round(Unit::potency(2)));
        assert_eq!(1000, *Unit::potency(3));
        assert_eq!(Myth32(3_410_000), m.round(Unit::potency(3)));
        assert_eq!(Myth32(3_400_000), m.floor(Unit::potency(4)));
        assert_eq!(-340.000, -(340.993_f64.floor()));
        assert_eq!(
            Myth32(-3_410_000),
            Myth32::from(-340.993).floor(Unit::potency(4))
        );
    }

    #[test]
    fn display() {
        let m = Myth32(12455);
        assert_eq!("1.2455", format!("{m}").as_str());
        assert_eq!("1.246", format!("{m:.3}").as_str());
        assert_eq!("1.2", format!("{m:.1}").as_str());
        assert_eq!("1.2455", format!("{m:.7}").as_str());
        assert_eq!("1", format!("{m:.0}").as_str());
        assert_eq!("-1.2455", format!("{:.7}", -m).as_str());
        let m = Myth32(-455);
        assert_eq!("-0.0455", format!("{m}").as_str());
        assert_eq!("-0.345", format!("{}", Myth32(-3450)).as_str());
        assert_eq!("-455", format!("{m:#}").as_str());
        let m = Myth32::from(4566.4689);
        assert_eq!(format!("{m:.3}"), "4566.469");
        let m = Myth32::ZERO;
        assert_eq!(format!("{m:.2}"), "0.00");
    }

    #[test]
    fn min_max() {
        let max = Myth32::MAX;
        let min = Myth32::MIN;

        assert_eq!(max.0, 2_147_483_647);
        assert_eq!(min.0, -2_147_483_648);
        assert_eq!(format!("{max:.0}"), "214748");
    }

    #[test]
    fn as_unit() {
        let m = Myth32::from(12456.832);
        assert_eq!(m.as_unit(Unit::CM), 1245.6832);
        assert_eq!(m.as_unit(Unit::METER), 12.456_832);
    }

    #[test]
    fn compute_absolute_value() {
        assert_eq!(Myth32::from(23455), Myth32::from(23455).abs());
        assert_eq!(Myth32::from(23455), Myth32::from(-23455).abs());
        assert_eq!(Myth32::from(0), Myth32::from(0).abs());
    }
}