Struct StochasticQueue

pub struct StochasticQueue<T> { /* private fields */ }

A queue which pops items at random uniformly. It cannot be iterated or peeked.

Implementations

impl<T> StochasticQueue<T>

pub fn with_capacity(cap: usize) -> Self

Create a queue with an initial capacity.

pub fn new() -> Self

Create a queue.

pub fn len(&self) -> usize

Get the amount of items in the queue. These items can be popped.

pub fn is_empty(&self) -> bool

Checks whether or not the queue has no items.

pub fn peek_iter(&self) -> impl Iterator<Item = &T>

Returns an iterator over all items in the queue without popping them. The order is arbitrary.

pub fn push(&mut self, val: T)

Adds an item to the queue. When it will be chosen to be popped is nondeterministic.

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

Removes an item from the queue, or returns None if the queue is empty. Which item will be popped is nondeterministic, but all items have an equal chance of being popped. If there is at least one item present, an item will definitely be popped.

pub fn clear(&mut self)

Removes all items from the queue.