Struct ImplicitMinimizerQueue

pub struct ImplicitMinimizerQueue<S: BuildHasher = DefaultHashBuilder> { /* private fields */ }

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

Implementations

impl ImplicitMinimizerQueue

pub fn new(width: u16) -> Self

Creates an empty ImplicitMinimizerQueue with the given width.

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

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

impl<S: BuildHasher> ImplicitMinimizerQueue<S>

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

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

Returns the width of the ImplicitMinimizerQueue.

pub fn is_empty(&self) -> bool

Returns true if the ImplicitMinimizerQueue is empty.

pub fn multiple_mins(&self) -> bool

Returns true if there are multiple minimizers in the queue.

pub fn get_min_pos(&self) -> usize

Returns the relative position of the leftmost minimizer.

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

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

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

Inserts x in the queue and updates the current minimizer.

pub fn insert_hash(&mut self, 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.