Struct milkpq::MilkPQ

pub struct MilkPQ<T: Ord> { /* fields omitted */ }

docs

Implementations

impl<T: Ord> MilkPQ<T>

pub fn new() -> Self

Create a new MilkPQ priority queue.

pub fn with_capacity(cap: usize) -> Self

Create a new MilkPQ with each subqueue having cap capacity.

pub fn with_queues(limit: usize) -> Self

Create a new MilkPQ with a given number of subqueues.

pub fn with_capacity_and_queues(cap: usize, limit: usize) -> Self

Create a new MilkPQ with a given capacity and subqueue count.

See [with_capacity()] and [with_queues()], as this is just a combination of the two.

pub fn push(&self, t: T)

Push an element into a subqueue.

pub fn pop(&self) -> Option<T>

Pop the maximum element in a priority subqueue.

This works by trying to lock a random subqueue and popping an element from that. Thus, this can have spurious Nones when some subqueues are empty while others are not. For a function that is guaranteed to pop an element if any exist in any subqueues, see [strong_pop()].

pub fn strong_pop(&self) -> Option<T>

Pop an element from the priority queue, but non-spuriously.

This will check every subqueue until it finds some element (not necessarily the maximum in the whole structure) and returns it, or will return None. Thus, it returns None iff the structure is truly empty.

pub fn into_sorted_vec(self) -> Vec<T>

Turns self into a descending sorted Vec.

pub fn clear(&self)

Clears all subqueues in the structure.

pub fn drain(&mut self) -> Vec<T>

Empty the contents of self into a Vec and leave self empty.

pub fn extend_ref<I: IntoIterator<Item = T>>(&self, iter: I)

Extend self using an IntoIterator.

Exactly like Extend, except it doesn't mutably borrow self.

Trait Implementations

impl<T: Ord + Clone> Clone for MilkPQ<T>

pub fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Ord + Debug> Debug for MilkPQ<T>

pub fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl<T: Ord> Default for MilkPQ<T>

pub fn default() -> Self

Returns the "default value" for a type.

impl<T: Ord> Extend<T> for MilkPQ<T>

pub fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T: Ord> From<MilkPQ<T>> for Vec<T>

pub fn from(pq: MilkPQ<T>) -> Self

Performs the conversion.

impl<T: Ord> FromIterator<T> for MilkPQ<T>

pub fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Ord> IntoIterator for MilkPQ<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.