rsvart 0.1.5

A small library for representing genomic variants and regions.
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

use crate::genomic::{Contiged, Stranded};
use crate::ops::{overlaps, Located, Transposable, Unit};

pub trait Overlaps<C, O = Self>
where
    O: ?Sized,
{
    fn overlaps(&self, other: &O) -> bool;
}

impl<C, T> Overlaps<C> for T
where
    C: Unit,
    T: Located<C>,
{
    fn overlaps(&self, other: &Self) -> bool {
        overlaps(self.start(), self.end(), other.start(), other.end())
    }
}

pub trait GenomicallyOverlaps<C, O = Self>
where
    O: ?Sized,
{
    fn overlaps(&self, other: &O) -> bool;
}

impl<C: Unit, T> GenomicallyOverlaps<C> for T
where
    C: Unit,
    T: Located<C> + Stranded + Contiged<C>,
{
    fn overlaps(&self, other: &Self) -> bool {
        if self.contig().ne(other.contig()) {
            return false;
        }

        if self.strand().eq(&other.strand()) {
            return overlaps(self.start(), self.end(), other.start(), other.end());
        }

        let other_start = other.start_on_strand(self.strand());
        let other_end = other.end_on_strand(self.strand());
        overlaps(self.start(), self.end(), &other_start, &other_end)
    }
}

#[cfg(test)]
mod test {
    use crate::ops::located::Located;
    use crate::ops::Overlaps;
    use rstest::rstest;

    pub struct TestRegion {
        start: u8,
        end: u8,
    }

    impl Located<u8> for TestRegion {
        fn start(&self) -> &u8 {
            &self.start
        }

        fn end(&self) -> &u8 {
            &self.end
        }
    }

    #[rstest]
    #[case(TestRegion { start: 4, end: 20 }, TestRegion { start: 1, end: 5 }, true)]
    #[case(TestRegion { start: 4, end: 20 }, TestRegion { start: 20, end: 29 }, false)]
    fn test_overlaps(
        #[case] region_1: TestRegion,
        #[case] region_2: TestRegion,
        #[case] expected: bool,
    ) {
        assert_eq!(region_1.overlaps(&region_2), expected);
    }
}