coitrees 0.4.0

A very fast data structure for overlap queries on sets of intervals.
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

//! # COITrees
//! `coitrees` implements a fast static interval tree data structure with genomic
//! data in mind.
//!
//! The data structure used a fairly standard interval tree, but with nodes stored
//! in van Emde Boas layout, which improves average cache locality, and thus
//! query performance. The downside is that building the tree is more expensive
//! so a relatively large number of queries needs to made for it to break even.
//!
//! The data structure `COITree` is constructed with an array of `IntervalNode`
//! structs which store integer, end-inclusive intervals along with associated
//! metadata. The tree can be queried directly for coverage or overlaps, or
//! through the intermediary `SortedQuerenty` which keeps track of some state
//! to accelerate overlaping queries.

mod interval;
pub use interval::*;

mod nosimd;
pub use nosimd::*;

#[cfg(all(target_feature = "avx2", not(feature = "nosimd")))]
mod avx;
#[cfg(all(target_feature = "avx2", not(feature = "nosimd")))]
pub use avx::*;

#[cfg(all(target_feature = "neon", not(feature = "nosimd")))]
mod neon;
#[cfg(all(target_feature = "neon", not(feature = "nosimd")))]
pub use neon::*;

// These are necessary mutually exclusive
#[cfg(all(
    not(feature = "nosimd"),
    not(target_feature = "avx2"),
    not(target_feature = "neon")
))]
pub type COITree<T, I> = BasicCOITree<T, I>;
#[cfg(all(target_feature = "avx2", not(feature = "nosimd")))]
pub type COITree<T, I> = AVXCOITree<T, I>;
#[cfg(all(target_feature = "neon", not(feature = "nosimd")))]
pub type COITree<T, I> = NeonCOITree<T, I>;

#[cfg(all(
    not(feature = "nosimd"),
    not(target_feature = "avx2"),
    not(target_feature = "neon")
))]
pub type COITreeSortedQuerent<'a, T, I> = BasicSortedQuerent<'a, T, I>;
#[cfg(all(target_feature = "avx2", not(feature = "nosimd")))]
pub type COITreeSortedQuerent<'a, T, I> = AVXSortedQuerent<'a, T, I>;
#[cfg(all(target_feature = "neon", not(feature = "nosimd")))]
pub type COITreeSortedQuerent<'a, T, I> = NeonSortedQuerent<'a, T, I>;