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
use core::hash::{BuildHasher, Hash};
use std::collections::VecDeque;
use strength_reduce::StrengthReducedU16;
use wyhash2::WyHash as DefaultBuildHasher;
/// A monotone queue that can compute consecutive minimizers in constant time.
///
/// # Examples
///
/// ```
/// use minimizer_queue::MinimizerQueue;
///
/// let mut queue = MinimizerQueue::new(3); // width 3
/// queue.insert(1);
/// queue.insert(2);
/// queue.insert(3);
/// queue.get_min(); // element with the smallest hash among 1, 2 and 3
///
/// queue.insert(4);
/// queue.get_min(); // element with the smallest hash among 2, 3 and 4
/// ```
pub struct MinimizerQueue<T: Hash + Copy, S: BuildHasher = DefaultBuildHasher> {
deq: VecDeque<(T, u64, u16)>,
width: StrengthReducedU16,
hash_builder: S,
pos: u16,
}
impl<T: Hash + Copy> MinimizerQueue<T> {
/// Creates an empty `MinimizerQueue` with the given width.
#[inline]
pub fn new(width: u16) -> Self {
Self::with_seed(width, width as u64)
}
/// Creates an empty `MinimizerQueue` with the given width and seed.
/// Changing the seed will change the ordering of the minimizers.
#[inline]
pub fn with_seed(width: u16, seed: u64) -> Self {
Self::with_hasher(width, DefaultBuildHasher::with_seed(seed))
}
}
impl<T: Hash + Copy, S: BuildHasher> MinimizerQueue<T, S> {
/// Creates an empty `MinimizerQueue` with the given width and hasher.
/// The hasher will define the ordering of the minimizers, based on their hashes.
pub fn with_hasher(width: u16, hash_builder: S) -> Self {
Self {
deq: VecDeque::with_capacity(width as usize),
width: StrengthReducedU16::new(width),
hash_builder,
pos: 0,
}
}
/// Returns the width of the `MinimizerQueue`.
#[inline]
pub fn width(&self) -> usize {
self.width.get() as usize
}
/// Returns the current minimizer.
#[inline]
pub fn get_min(&self) -> T {
debug_assert!(!self.deq.is_empty(), "MinimizerQueue is empty");
self.deq[0].0
}
/// Returns the current minimizer and its relative position in the queue.
#[inline]
pub fn get_min_pos(&self) -> (T, usize) {
debug_assert!(!self.deq.is_empty(), "MinimizerQueue is empty");
let (x, _, pos) = self.deq[0];
let rel_pos = ((self.width.get() - self.pos + pos) % self.width) as usize;
(x, rel_pos)
}
/// Inserts `x` in the queue and updates the current minimizer.
#[inline]
pub fn insert(&mut self, x: T) {
self.insert_with_hash(x, self.hash_builder.hash_one(x))
}
/// Inserts `x` in the queue with the given hash and updates the current minimizer.
pub fn insert_with_hash(&mut self, x: T, hash: u64) {
if !self.deq.is_empty() && self.deq[0].2 == self.pos {
self.deq.pop_front();
}
let mut i = self.deq.len();
while i > 0 && hash < self.deq[i - 1].1 {
i -= 1;
}
self.deq.truncate(i);
self.deq.push_back((x, hash, self.pos));
self.pos = (self.pos + 1) % self.width;
}
/// Clears the deque, removing all elements.
#[inline]
pub fn clear(&mut self) {
self.deq.clear()
}
}
/// A monotone queue that can compute the positions of consecutive minimizers in constant time.
///
/// # Examples
///
/// ```
/// use minimizer_queue::ImplicitMinimizerQueue;
///
/// let mut queue = ImplicitMinimizerQueue::new(3); // width 3
/// queue.insert(&1);
/// queue.insert(&2);
/// queue.insert(&3);
/// queue.get_min_pos(); // position of the element with the smallest hash among 1, 2 and 3
///
/// queue.insert(&4);
/// queue.get_min_pos(); // position of the element with the smallest hash among 2, 3 and 4
/// ```
pub struct ImplicitMinimizerQueue<S: BuildHasher = DefaultBuildHasher> {
deq: VecDeque<(u64, u16)>,
width: StrengthReducedU16,
hash_builder: S,
pos: u16,
}
impl ImplicitMinimizerQueue {
/// Creates an empty `ImplicitMinimizerQueue` with the given width.
#[inline]
pub fn new(width: u16) -> Self {
Self::with_seed(width, width as u64)
}
/// Creates an empty `ImplicitMinimizerQueue` with the given width and seed.
/// Changing the seed will change the ordering of the minimizers.
#[inline]
pub fn with_seed(width: u16, seed: u64) -> Self {
Self::with_hasher(width, DefaultBuildHasher::with_seed(seed))
}
}
impl<S: BuildHasher> ImplicitMinimizerQueue<S> {
/// Creates an empty `ImplicitMinimizerQueue` with the given width and hasher.
/// The hasher will define the ordering of the minimizers, based on their hashes.
pub fn with_hasher(width: u16, hash_builder: S) -> Self {
Self {
deq: VecDeque::with_capacity(width as usize),
width: StrengthReducedU16::new(width),
hash_builder,
pos: 0,
}
}
/// Returns the width of the `ImplicitMinimizerQueue`.
#[inline]
pub fn width(&self) -> usize {
self.width.get() as usize
}
/// Returns the relative position of the current minimizer.
#[inline]
pub fn get_min_pos(&self) -> usize {
debug_assert!(!self.deq.is_empty(), "ImplicitMinimizerQueue is empty");
let (_, pos) = self.deq[0];
((self.width.get() - self.pos + pos) % self.width) as usize
}
/// Inserts `x` in the queue and updates the current minimizer.
#[inline]
pub fn insert<T: Hash>(&mut self, x: &T) {
self.insert_hash(self.hash_builder.hash_one(x))
}
/// Inserts `x` in the queue with the given hash and updates the current minimizer.
pub fn insert_hash(&mut self, hash: u64) {
if !self.deq.is_empty() && self.deq[0].1 == self.pos {
self.deq.pop_front();
}
let mut i = self.deq.len();
while i > 0 && hash < self.deq[i - 1].0 {
i -= 1;
}
self.deq.truncate(i);
self.deq.push_back((hash, self.pos));
self.pos = (self.pos + 1) % self.width;
}
/// Clears the deque, removing all elements.
#[inline]
pub fn clear(&mut self) {
self.deq.clear()
}
}
#[cfg(test)]
mod tests {
use super::*;
use nohash_hasher::BuildNoHashHasher;
#[test]
fn test_get_min() {
let mut queue = MinimizerQueue::with_hasher(3, BuildNoHashHasher::<usize>::default());
let vals = [1usize, 2, 3, 0, 7, 8, 9, 100, 3, 4, 7, 8];
let mut mins = Vec::with_capacity(vals.len() - queue.width() + 1);
for &val in vals.iter().take(queue.width() - 1) {
queue.insert(val);
}
for &val in vals.iter().skip(queue.width() - 1) {
queue.insert(val);
mins.push(queue.get_min());
}
assert_eq!(mins, vec![1, 0, 0, 0, 7, 8, 3, 3, 3, 4]);
}
#[test]
fn test_get_min_pos() {
let mut queue = MinimizerQueue::with_hasher(3, BuildNoHashHasher::<usize>::default());
let vals = [1usize, 2, 3, 0, 7, 8, 9, 100, 3, 4, 7, 8];
let mut mins_pos = Vec::with_capacity(vals.len() - queue.width() + 1);
for &val in vals.iter().take(queue.width() - 1) {
queue.insert(val);
}
for &val in vals.iter().skip(queue.width() - 1) {
queue.insert(val);
mins_pos.push(queue.get_min_pos());
}
assert_eq!(
mins_pos,
vec![
(1, 0),
(0, 2),
(0, 1),
(0, 0),
(7, 0),
(8, 0),
(3, 2),
(3, 1),
(3, 0),
(4, 0)
]
);
}
#[test]
fn test_implicit_get_min_pos() {
let mut queue =
ImplicitMinimizerQueue::with_hasher(3, BuildNoHashHasher::<usize>::default());
let vals = [1usize, 2, 3, 0, 7, 8, 9, 100, 3, 4, 7, 8];
let mut mins_pos = Vec::with_capacity(vals.len() - queue.width() + 1);
for val in vals.iter().take(queue.width() - 1) {
queue.insert(val);
}
for val in vals.iter().skip(queue.width() - 1) {
queue.insert(val);
mins_pos.push(queue.get_min_pos());
}
assert_eq!(mins_pos, vec![0, 2, 1, 0, 0, 0, 2, 1, 0, 0]);
}
}