Struct FlatQueue 

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

FlatQueue

Description

A priority queue implemented using a binary heap.

A port from the flatqueue code.

Usage

use gistools::data_structures::FlatQueue;

let mut q = FlatQueue::new();
q.push(1, 1.0);
q.push(3, 3.0);
q.push(2, 2.0);
assert_eq!(q.pop(), Some(1));
assert_eq!(q.pop(), Some(2));
assert_eq!(q.pop(), Some(3));
assert_eq!(q.pop(), None);

Implementations

impl<T: Clone> FlatQueue<T>

pub fn new() -> Self

Creates a new empty queue.

pub fn len(&self) -> usize

Returns the number of items.

pub fn is_empty(&self) -> bool

Returns whether the queue is empty.

pub fn clear(&mut self)

Clears all items from the queue.

pub fn push(&mut self, item: T, priority: f64)

Adds item to the queue with the specified priority.

priority must be a number. Items are sorted and returned from low to high priority. Multiple items with the same priority value can be added to the queue, but there is no guaranteed order between these items.

Parameters

• item: the item to add
• priority: the priority of the item

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

Removes and returns the item from the head of this queue, which is one of the items with the lowest priority. If this queue is empty, returns undefined.

Returns

the item from the head of this queue

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

Returns the item with the lowest priority without removing it.

pub fn peek_value(&self) -> Option<f64>

Returns the priority of the lowest-priority item.

pub fn shrink(&mut self)

Shrinks underlying arrays to current length.

Trait Implementations

impl<T: Clone> Default for FlatQueue<T>

fn default() -> Self

Returns the “default value” for a type.