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
|
[![Build status badge][]][build status]
intervaltree
============
A mutable, self-balancing interval tree for Python 2 and 3. Queries may be by point, by range overlap, or by range envelopment.
This library was designed to allow tagging text and time intervals, where the intervals include the lower bound but not the upper bound.
Installing
----------
```sh
pip install intervaltree
```
Features
--------
* Supports Python 2.6+ and Python 3.2+
* Initializing
* blank `tree = IntervalTree()`
* from an iterable of `Interval` objects (`tree = IntervalTree(intervals)`)
* from an iterable of tuples (`tree = IntervalTree.from_tuples(interval_tuples)`)
* Insertions
* `tree[begin:end] = data`
* `tree.add(interval)`
* `tree.addi(begin, end, data)`
* Deletions
* `tree.remove(interval)` (raises `ValueError` if not present)
* `tree.discard(interval)` (quiet if not present)
* `tree.removei(begin, end, data)` (short for `tree.remove(Interval(begin, end, data))`)
* `tree.discardi(begin, end, data)` (short for `tree.discard(Interval(begin, end, data))`)
* `tree.remove_overlap(point)`
* `tree.remove_overlap(begin, end)` (removes all overlapping the range)
* `tree.remove_envelop(begin, end)` (removes all enveloped in the range)
* Overlap queries
* `tree[point]`
* `tree[begin:end]`
* `tree.search(point)`
* `tree.search(begin, end)`
* Envelop queries
* `tree.search(begin, end, strict=True)`
* Membership queries
* `interval_obj in tree` (this is fastest, O(1))
* `tree.containsi(begin, end, data)`
* `tree.overlaps(point)`
* `tree.overlaps(begin, end)`
* Iterable
* `for interval_obj in tree:`
* `tree.items()`
* Sizing
* `len(tree)`
* `tree.is_empty()`
* `not tree`
* `tree.begin()` (the `begin` coordinate of the leftmost interval)
* `tree.end()` (the `end` coordinate of the rightmost interval)
* Set-like operations
* union
* `result_tree = tree.union(iterable)`
* `result_tree = tree1 | tree2`
* `tree.update(iterable)`
* `tree |= other_tree`
* difference
* `result_tree = tree.difference(iterable)`
* `result_tree = tree1 - tree2`
* `tree.difference_update(iterable)`
* `tree -= other_tree`
* intersection
* `result_tree = tree.intersection(iterable)`
* `result_tree = tree1 & tree2`
* `tree.intersection_update(iterable)`
* `tree &= other_tree`
* symmetric difference
* `result_tree = tree.symmetric_difference(iterable)`
* `result_tree = tree1 ^ tree2`
* `tree.symmetric_difference_update(iterable)`
* `tree ^= other_tree`
* comparison
* `tree1.issubset(tree2)` or `tree1 <= tree2`
* `tree1 <= tree2`
* `tree1.issuperset(tree2)` or `tree1 > tree2`
* `tree1 >= tree2`
* `tree1 == tree2`
* Restructuring
* `chop(begin, end)` (slice intervals and remove everything between `begin` and `end`)
* `slice(point)` (slice intervals at `point`)
* `split_overlaps()` (slice at all interval boundaries)
* Copying and typecasting
* `IntervalTree(tree)` (`Interval` objects are same as those in tree)
* `tree.copy()` (`Interval` objects are shallow copies of those in tree)
* `set(tree)` (can later be fed into `IntervalTree()`)
* `list(tree)` (ditto)
* Pickle-friendly
* Automatic AVL balancing
Examples
--------
* Getting started
``` python
>>> from intervaltree import Interval, IntervalTree
>>> t = IntervalTree()
>>> t
IntervalTree()
```
* Adding intervals - any object works!
``` python
>>> t[1:2] = "1-2"
>>> t[4:7] = (4, 7)
>>> t[5:9] = {5: 9}
```
* Query by point
The result of a query is a `set` object, so if ordering is important,
you must sort it first.
``` python
>>> sorted(t[6])
[Interval(4, 7, (4, 7)), Interval(5, 9, {5: 9})]
>>> sorted(t[6])[0]
Interval(4, 7, (4, 7))
```
* Query by range
Note that ranges are inclusive of the lower limit, but non-inclusive of the upper limit. So:
``` python
>>> sorted(t[2:4])
[]
```
But:
``` python
>>> sorted(t[1:5])
[Interval(1, 2, '1-2'), Interval(4, 7, (4, 7))]
```
* Accessing an `Interval` object
``` python
>>> iv = Interval(4, 7, (4, 7))
>>> iv.begin
4
>>> iv.end
7
>>> iv.data
(4, 7)
>>> begin, end, data = iv
>>> begin
4
>>> end
7
>>> data
(4, 7)
```
* Constructing from lists of intervals
We could have made a similar tree this way:
``` python
>>> ivs = [(1, 2), (4, 7), (5, 9)]
>>> t = IntervalTree(
... Interval(begin, end, "%d-%d" % (begin, end)) for begin, end in ivs
... )
```
Or, if we don't need the data fields:
``` python
>>> t2 = IntervalTree(Interval(*iv) for iv in ivs)
```
* Removing intervals
``` python
>>> t.remove( Interval(1, 2, "1-2") )
>>> sorted(t)
[Interval(4, 7, '4-7'), Interval(5, 9, '5-9')]
>>> t.remove( Interval(500, 1000, "Doesn't exist")) # raises ValueError
Traceback (most recent call last):
ValueError
>>> t.discard(Interval(500, 1000, "Doesn't exist")) # quietly does nothing
>>> del t[5] # same as t.remove_overlap(5)
>>> t
IntervalTree()
```
We could also empty a tree entirely:
``` python
>>> t2.clear()
>>> t2
IntervalTree()
```
Or remove intervals that overlap a range:
``` python
>>> t = IntervalTree([
... Interval(0, 10),
... Interval(10, 20),
... Interval(20, 30),
... Interval(30, 40)])
>>> t.remove_overlap(25, 35)
>>> sorted(t)
[Interval(0, 10), Interval(10, 20)]
```
We can also remove only those intervals completely enveloped in a range:
``` python
>>> t.remove_envelop(5, 20)
>>> sorted(t)
[Interval(0, 10)]
```
* Chopping
We could also chop out parts of the tree:
``` python
>>> t = IntervalTree([Interval(0, 10)])
>>> t.chop(3, 7)
>>> sorted(t)
[Interval(0, 3), Interval(7, 10)]
```
To modify the new intervals' data fields based on which side of the interval is being chopped:
``` python
>>> def datafunc(iv, islower):
... oldlimit = iv[islower]
... return "oldlimit: {0}, islower: {1}".format(oldlimit, islower)
>>> t = IntervalTree([Interval(0, 10)])
>>> t.chop(3, 7, datafunc)
>>> sorted(t)[0]
Interval(0, 3, 'oldlimit: 10, islower: True')
>>> sorted(t)[1]
Interval(7, 10, 'oldlimit: 0, islower: False')
```
* Slicing
You can also slice intervals in the tree without removing them:
``` python
>>> t = IntervalTree([Interval(0, 10), Interval(5, 15)])
>>> t.slice(3)
>>> sorted(t)
[Interval(0, 3), Interval(3, 10), Interval(5, 15)]
```
You can also set the data fields, for example, re-using `datafunc()` from above:
``` python
>>> t = IntervalTree([Interval(5, 15)])
>>> t.slice(10, datafunc)
>>> sorted(t)[0]
Interval(5, 10, 'oldlimit: 15, islower: True')
>>> sorted(t)[1]
Interval(10, 15, 'oldlimit: 5, islower: False')
```
Future improvements
-------------------
See the [issue tracker][] on GitHub.
Based on
--------
* Eternally Confuzzled's [AVL tree][Confuzzled AVL tree]
* Wikipedia's [Interval Tree][Wiki intervaltree]
* Heavily modified from Tyler Kahn's [Interval Tree implementation in Python][Kahn intervaltree] ([GitHub project][Kahn intervaltree GH])
* Incorporates contributions from:
* [konstantint/Konstantin Tretyakov][Konstantin intervaltree] of the University of Tartu (Estonia)
* [siniG/Avi Gabay][siniG intervaltree]
* [lmcarril/Luis M. Carril][lmcarril intervaltree] of the Karlsruhe Institute for Technology (Germany)
Copyright
---------
* [Chaim-Leib Halbert][GH], 2013-2015
* Modifications, [Konstantin Tretyakov][Konstantin intervaltree], 2014
Licensed under the [Apache License, version 2.0][Apache].
The source code for this project is at https://github.com/chaimleib/intervaltree
[build status badge]: https://travis-ci.org/chaimleib/intervaltree.svg?branch=master
[build status]: https://travis-ci.org/chaimleib/intervaltree
[GH]: https://github.com/chaimleib/intervaltree
[issue tracker]: https://github.com/chaimleib/intervaltree/issues
[Konstantin intervaltree]: https://github.com/konstantint/PyIntervalTree
[siniG intervaltree]: https://github.com/siniG/intervaltree
[lmcarril intervaltree]: https://github.com/lmcarril/intervaltree
[Confuzzled AVL tree]: http://www.eternallyconfuzzled.com/tuts/datastructures/jsw_tut_avl.aspx
[Wiki intervaltree]: http://en.wikipedia.org/wiki/Interval_tree
[Kahn intervaltree]: http://zurb.com/forrst/posts/Interval_Tree_implementation_in_python-e0K
[Kahn intervaltree GH]: https://github.com/tylerkahn/intervaltree-python
[Apache]: http://www.apache.org/licenses/LICENSE-2.0
|