arranged 0.1.2

Statically bounds-checked (machine-word-abstracting? TBD) ranged types as zero or low-runtime overhead abstractions providing safe (no unintentional overflow) arithmetic.
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

use arith_traits::IUnaryWrappingOps;
use assert2::assert;

use crate::{Ranged, RiI64, RiU64};

#[test]
fn range_with_nonnegative_start_and_end_returns_original_value() {
    // Given
    type OneToOneHundred = RiU64<1, 100>;
    let value = 42;
    let sut = Ranged::<OneToOneHundred>::from(value);
    let expected = Ranged::<OneToOneHundred>::from(value);

    // When
    let result = sut.wrapping_abs();

    // Then
    assert!(result == expected);
}

#[test]
fn range_with_nonnegative_start_and_end_with_minimum_value_returns_original_value() {
    // Given
    type ZeroToNineNinetyNine = RiU64<0, 999>;
    let value = 0;
    let sut = Ranged::<ZeroToNineNinetyNine>::from(value);
    let expected = Ranged::<ZeroToNineNinetyNine>::from(value);

    // When
    let result = sut.wrapping_abs();

    // Then
    assert!(result == expected);
}

#[test]
fn range_with_nonnegative_start_and_end_with_maximum_value_returns_original_value() {
    // Given
    type OneToTen = RiU64<1, 10>;
    let value = 10;
    let sut = Ranged::<OneToTen>::from(value);
    let expected = Ranged::<OneToTen>::from(value);

    // When
    let result = sut.wrapping_abs();

    // Then
    assert!(result == expected);
}

#[test]
fn range_with_negative_start_nonnegative_end_and_nonnegative_value_returns_original_value() {
    // Given
    type NegativeOneHundredToOneHundred = RiI64<-100, 100>;
    let value = 21;
    let sut = Ranged::<NegativeOneHundredToOneHundred>::from(value);
    let expected = Ranged::<NegativeOneHundredToOneHundred>::from(value);

    // When
    let result = sut.wrapping_abs();

    // Then
    assert!(result == expected);
}

#[test]
fn range_with_negative_start_nonnegative_end_and_negative_value_returns_positive_in_bounds_value() {
    // Given
    type NegativeOneHundredToOneHundred = RiI64<-100, 100>;
    let value = -21;
    let sut = Ranged::<NegativeOneHundredToOneHundred>::from(value);
    let expected = Ranged::<NegativeOneHundredToOneHundred>::from(-value);

    // When
    let result = sut.wrapping_abs();

    // Then
    assert!(result == expected);
}

#[test]
fn range_with_negative_start_nonnegative_end_and_negative_value_returns_wrapped_value() {
    // Given
    type ZeroToNineNinetyNine = RiI64<-100, 20>;
    let value = -35;
    let sut = Ranged::<ZeroToNineNinetyNine>::from(value);
    let expected = Ranged::<ZeroToNineNinetyNine>::from(-85);

    // When
    let result = sut.wrapping_abs();

    // Then
    assert!(result == expected);
}

#[test]
fn range_with_negative_start_nonnegative_end_and_min_value_returns_wrapped_value() {
    // Given
    type ZeroToNineNinetyNine = RiI64<-100, 20>;
    let value = -100;
    let sut = Ranged::<ZeroToNineNinetyNine>::from(value);
    let expected = Ranged::<ZeroToNineNinetyNine>::from(-20);

    // When
    let result = sut.wrapping_abs();

    // Then
    assert!(result == expected);
}

#[test]
fn range_with_negative_start_nonnegative_end_and_max_value_returns_wrapped_value() {
    // Given
    type ZeroToNineNinetyNine = RiI64<-100, 20>;
    let value = 20;
    let sut = Ranged::<ZeroToNineNinetyNine>::from(value);
    let expected = Ranged::<ZeroToNineNinetyNine>::from(value);

    // When
    let result = sut.wrapping_abs();

    // Then
    assert!(result == expected);
}

#[test]
fn range_with_negative_start_negative_end_and_negative_value_returns_wrapped_value() {
    // Given
    type NegativeOneHundredToOneHundred = RiI64<-50, -1>;
    let value = -11;
    let sut = Ranged::<NegativeOneHundredToOneHundred>::from(value);
    let expected = Ranged::<NegativeOneHundredToOneHundred>::from(-38);

    // When
    let result = sut.wrapping_abs();

    // Then
    assert!(result == expected);
}

#[test]
fn range_with_negative_start_negative_end_and_min_value_returns_wrapped_value() {
    // Given
    type ZeroToNineNinetyNine = RiI64<-50, -1>;
    let value = -50;
    let sut = Ranged::<ZeroToNineNinetyNine>::from(value);
    let expected = Ranged::<ZeroToNineNinetyNine>::from(-49);

    // When
    let result = sut.wrapping_abs();

    // Then
    assert!(result == expected);
}

#[test]
fn range_with_negative_start_negative_end_and_max_value_returns_wrapped_value() {
    // Given
    type ZeroToNineNinetyNine = RiI64<-50, -1>;
    let value = -1;
    let sut = Ranged::<ZeroToNineNinetyNine>::from(value);
    let expected = Ranged::<ZeroToNineNinetyNine>::from(-48);

    // When
    let result = sut.wrapping_abs();

    // Then
    assert!(result == expected);
}