chia 0.1.0

Implementation of `clvm` for Chia Network's cryptocurrency
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

use std::cmp::Ordering;
use std::collections::BTreeSet;
use std::ops::Bound::{Excluded, Included, Unbounded};

// this is a data structure that holds integer ranges with n log n lookups for
// overlapping ranges.

#[derive(Copy, Clone)]
enum RangeEntry {
    Start(u32),
    End(u32),
}

impl RangeEntry {
    fn index(&self) -> &u32 {
        match self {
            RangeEntry::Start(p) => p,
            RangeEntry::End(p) => p,
        }
    }
}

impl PartialEq for RangeEntry {
    fn eq(&self, other: &Self) -> bool {
        self.index() == other.index()
    }
}

impl Eq for RangeEntry {}

impl Ord for RangeEntry {
    fn cmp(&self, other: &Self) -> Ordering {
        self.index().cmp(other.index())
    }
}

impl PartialOrd for RangeEntry {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.index().cmp(other.index()))
    }
}

pub struct RangeSet {
    entries: BTreeSet<RangeEntry>,
}

impl RangeSet {
    pub fn new() -> Self {
        RangeSet {
            entries: BTreeSet::new(),
        }
    }

    // returns an ordered list of ranges *in between* the ranges that exist in
    // the RangeSet, within the specified [start, end)
    //
    // consider the following RangeSet:
    // ----****------*****----
    // a request for this range:
    //  |--------------|
    // returns:
    //  ***----******--
    pub fn not_overlapping(&self, start: u32, end: u32) -> Vec<(u32, u32)> {
        assert!(start < end);

        let ranges = self.entries.range((
            Included(RangeEntry::Start(start)),
            Included(RangeEntry::End(end)),
        ));
        let mut ret = Vec::<(u32, u32)>::new();

        let mut current_start: Option<u32> = Some(start);
        let mut num = 0;
        for e in ranges {
            num += 1;
            match e {
                RangeEntry::End(p) => {
                    if p < &end {
                        current_start = Some(*p);
                    }
                }
                RangeEntry::Start(p) => {
                    if current_start.unwrap() < *p {
                        ret.push((current_start.unwrap(), *p));
                    }
                    current_start = None;
                }
            }
        }

        if num == 0 {
            // if we didn't find either a start or an end, we don't know whether
            // we're entirely inside a range or entirely outside. Look up the
            // entry before start.
            let mut before = self
                .entries
                .range((Unbounded, Excluded(RangeEntry::Start(start))));
            if let Some(RangeEntry::Start(_)) = before.next_back() {
                // we're entirely inside a range, so return the empty set
                return ret;
            }
        }

        if let Some(s) = current_start {
            if s < end {
                assert!(s < end);
                ret.push((s, end));
            }
        }
        ret
    }

    // adds a new range. This will merge with any existing range
    // end is one-past end
    pub fn add(&mut self, start: u32, end: u32) {
        assert!(start < end);
        let entries = self.entries.range((
            Included(RangeEntry::Start(start)),
            Included(RangeEntry::End(end)),
        ));

        // there is no way of removing a range of entries from a BTreeSet, so we
        // need to copy all the elements out and then remove them one at a time
        let mut to_remove = Vec::<RangeEntry>::new();
        for e in entries {
            to_remove.push(*e);
        }

        if to_remove.is_empty() {
            // if we didn't find either a start or an end, we don't know whether
            // we're entirely inside a range or entirely outside. Look up the
            // entry before start.
            let mut before = self
                .entries
                .range((Unbounded, Excluded(RangeEntry::Start(start))));
            if let Some(RangeEntry::Start(_)) = before.next_back() {
                // if we're entirely inside an existing range, it's a no-op
                return;
            }
        }

        let first: Option<RangeEntry> = to_remove.first().copied();
        let last: Option<RangeEntry> = to_remove.last().copied();

        for e in to_remove {
            self.entries.remove(&e);
        }

        // depending on what kinds of entries we removed, we may or may not need
        // to insert any new ones.

        // e.g. if we removed the end of one range and the start of another, we
        // just merged them and don't need any new entries.

        match first {
            Some(RangeEntry::Start(_)) | None => {
                self.entries.insert(RangeEntry::Start(start));
            }
            _ => (),
        }
        match last {
            Some(RangeEntry::End(_)) | None => {
                self.entries.insert(RangeEntry::End(end));
            }
            _ => (),
        }
    }
}

#[test]
fn test_rangeset() {
    let mut s = RangeSet::new();

    assert_eq!(s.not_overlapping(0, u32::MAX), vec![(0, u32::MAX)]);

    s.add(1, 5);
    // now we have:
    // -****------------------
    assert_eq!(s.not_overlapping(0, u32::MAX), vec![(0, 1), (5, u32::MAX)]);
    assert_eq!(s.not_overlapping(2, u32::MAX), vec![(5, u32::MAX)]);
    assert_eq!(s.not_overlapping(0, 3), vec![(0, 1)]);
    assert_eq!(s.not_overlapping(5, u32::MAX), vec![(5, u32::MAX)]);
    assert_eq!(s.not_overlapping(0, 1), vec![(0, 1)]);
    assert_eq!(s.not_overlapping(1, 10), vec![(5, 10)]);

    s.add(7, 10);
    // now we have:
    // -****--***-------------
    assert_eq!(
        s.not_overlapping(0, u32::MAX),
        vec![(0, 1), (5, 7), (10, u32::MAX)]
    );
    assert_eq!(s.not_overlapping(2, u32::MAX), vec![(5, 7), (10, u32::MAX)]);
    assert_eq!(s.not_overlapping(0, 3), vec![(0, 1)]);
    assert_eq!(s.not_overlapping(0, 1), vec![(0, 1)]);
    assert_eq!(s.not_overlapping(6, u32::MAX), vec![(6, 7), (10, u32::MAX)]);
    assert_eq!(s.not_overlapping(8, u32::MAX), vec![(10, u32::MAX)]);
    assert_eq!(s.not_overlapping(6, 9), vec![(6, 7)]);
    assert_eq!(s.not_overlapping(10, u32::MAX), vec![(10, u32::MAX)]);
    assert_eq!(s.not_overlapping(7, 20), vec![(10, 20)]);

    // join two ranges
    s.add(4, 7);
    // now we have:
    // -*********-------------
    assert_eq!(s.not_overlapping(0, 1), vec![(0, 1)]);
    assert_eq!(s.not_overlapping(0, u32::MAX), vec![(0, 1), (10, u32::MAX)]);
    assert_eq!(s.not_overlapping(3, u32::MAX), vec![(10, u32::MAX)]);
    assert_eq!(s.not_overlapping(0, 7), vec![(0, 1)]);
    assert_eq!(s.not_overlapping(10, u32::MAX), vec![(10, u32::MAX)]);
    assert_eq!(s.not_overlapping(1, 20), vec![(10, 20)]);

    // add entirely within the range
    s.add(4, 7);
    // we still have:
    // -*********-------------
    assert_eq!(s.not_overlapping(0, 1), vec![(0, 1)]);
    assert_eq!(s.not_overlapping(0, u32::MAX), vec![(0, 1), (10, u32::MAX)]);
    assert_eq!(s.not_overlapping(3, u32::MAX), vec![(10, u32::MAX)]);
    assert_eq!(s.not_overlapping(0, 7), vec![(0, 1)]);
    assert_eq!(s.not_overlapping(10, u32::MAX), vec![(10, u32::MAX)]);
    assert_eq!(s.not_overlapping(1, 20), vec![(10, 20)]);
}