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
// Copyright (C) 2024 Philipp Benner
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the “Software”), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
/* -------------------------------------------------------------------------- */
use std::cmp::{max, min};
use std::fmt;
/* -------------------------------------------------------------------------- */
/// A struct representing a closed-open interval with a start (`from`) and end (`to`) position.
///
/// `Range` represents a genomic or numeric range with an inclusive `from` bound and an exclusive `to` bound.
/// This interval can be used for calculating intersections or checking overlaps with other ranges.
///
/// # Fields
///
/// - `from`: The start position of the range (inclusive).
/// - `to`: The end position of the range (exclusive).
///
/// # Examples
///
/// ```
/// use rustynetics::range::Range;
///
/// let range = Range::new(100, 200);
/// println!("{}", range); // Output: [100, 200)
/// ```
#[derive(Clone, Copy, Debug)]
pub struct Range {
pub from: usize,
pub to: usize,
}
/* -------------------------------------------------------------------------- */
impl Range {
/// Creates a new `Range` with specified `from` and `to` bounds.
///
/// # Parameters
///
/// - `from`: The inclusive start position of the range.
/// - `to`: The exclusive end position of the range.
///
/// # Panics
///
/// This function panics if `from` is greater than `to`, as it would result in an invalid range.
///
/// # Examples
///
/// ```
/// use rustynetics::range::Range;
///
/// let range = Range::new(5, 10);
/// ```
pub fn new(from: usize, to: usize) -> Range {
if from > to {
panic!(
"NewRange(): invalid range, i.e. from > to (from={}, to={})",
from, to
);
}
Range { from, to }
}
/// Computes the intersection of this range with another range.
///
/// The intersection of two ranges is the overlapping interval where both ranges meet.
/// If there is no overlap, the intersection is a zero-length range at the maximum `from` position.
///
/// # Parameters
///
/// - `other`: A reference to another `Range` with which to calculate the intersection.
///
/// # Returns
///
/// A `Range` representing the intersection of the two ranges. If the ranges do not overlap,
/// a zero-length range is returned with `from == to`.
///
/// # Examples
///
/// ```
/// use rustynetics::range::Range;
///
/// let range1 = Range::new(10, 20);
/// let range2 = Range::new(15, 25);
/// let intersection = range1.intersection(&range2);
/// println!("{}", intersection); // Output: [15, 20)
/// ```
pub fn intersection(&self, other: &Range) -> Range {
let from = max(self.from, other.from);
let to = min(self.to, other.to);
if to < from {
Range::new(from, from)
} else {
Range::new(from, to)
}
}
}
/* -------------------------------------------------------------------------- */
impl PartialEq for Range {
/// Compares two `Range` objects for equality.
///
/// Two `Range` instances are considered equal if they have the same `from` and `to` values.
///
/// # Examples
///
/// ```
/// use rustynetics::range::Range;
///
/// let range1 = Range::new(5, 10);
/// let range2 = Range::new(5, 10);
/// assert_eq!(range1, range2);
/// ```
fn eq(&self, other: &Self) -> bool {
self.from == other.from && self.to == other.to
}
}
/* -------------------------------------------------------------------------- */
impl fmt::Display for Range {
/// Formats the `Range` as a string for display.
///
/// The format used is `[from, to)`, where `from` is inclusive and `to` is exclusive.
///
/// # Examples
///
/// ```
/// use rustynetics::range::Range;
///
/// let range = Range::new(5, 10);
/// println!("{}", range); // Output: [5, 10)
/// ```
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.pad(&format!("[{}, {})", self.from, self.to))
}
}