Struct MinimizerQueue

pub struct MinimizerQueue<T: Hash + Copy, S: BuildHasher = DefaultHashBuilder> { /* private fields */ }

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

Implementations

impl<T: Hash + Copy> MinimizerQueue<T>

pub fn new(width: u16) -> Self

Creates an empty MinimizerQueue with the given width.

pub fn with_seed(width: u16, seed: u64) -> Self

Creates an empty MinimizerQueue with the given width and seed. Changing the seed will change the ordering of the minimizers.

impl<T: Hash + Copy, S: BuildHasher> MinimizerQueue<T, S>

pub fn with_hasher(width: u16, hash_builder: S) -> Self

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 width(&self) -> usize

Returns the width of the MinimizerQueue.

pub fn is_empty(&self) -> bool

Returns true if the MinimizerQueue is empty.

pub fn multiple_mins(&self) -> bool

Returns true if there are multiple minimizers in the queue.

pub fn get_min(&self) -> T

Returns the leftmost minimizer in the queue.

pub fn get_min_pos(&self) -> (T, usize)

Returns the leftmost minimizer and its relative position in the queue.

pub fn get_inner_min_pos(&self) -> (T, usize, Option<(T, usize)>)

Returns the innermost minimizer and its relative position in the queue, with a second choice in case of tie.

pub fn insert(&mut self, x: T)

Inserts x in the queue and updates the current minimizer.

pub fn insert_with_hash(&mut self, x: T, hash: u64)

Inserts x in the queue with the given hash and updates the current minimizer.

pub fn clear(&mut self)

Clears the deque, removing all elements.