Struct PopulatedBinaryHeap

Source

pub struct PopulatedBinaryHeap<T>(/* private fields */);

Implementations§

Source §

impl<T: Ord> PopulatedBinaryHeap<T>

Source

pub fn new(value: T) -> PopulatedBinaryHeap<T>

Creates a binary heap populated with a single value.

Source

pub fn with_capacity(capacity: NonZeroUsize, value: T) -> PopulatedBinaryHeap<T>

Creates a binary populated with a single value and the given capacity.

Source

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

Pushes an item onto the binary heap.

Source

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

Consumes the PopulatedBinaryHeap and returns a populated vector in sorted (ascending) order.

Source

pub fn append(&mut self, other: &mut BinaryHeap<T>)

Moves all the elements of other into self, leaving other empty.

Source

pub fn retain(self, predicate: impl FnMut(&T) -> bool) -> BinaryHeap<T>

Retains only the elements specified by the predicate.

In other words, remove all elements e for which f(&e) returns false. The elements are visited in unsorted (and unspecified) order.

Note that the binary heap is not guaranteed to be populated after calling this method.

use populated::PopulatedBinaryHeap;
use std::num::NonZeroUsize;

let mut binary_heap = PopulatedBinaryHeap::with_capacity(NonZeroUsize::new(5).unwrap(), 1);
binary_heap.push(2);
binary_heap.push(3);
let binary_heap = binary_heap.retain(|&x| x > 2);
assert_eq!(binary_heap.len(), 1);

Source

pub fn pop(self) -> (T, BinaryHeap<T>)

Removes the greatest item from the binary heap and returns it along with the remaining binary heap. Note that the returned binary heap is not guaranteed to be populated.

use populated::PopulatedBinaryHeap;
use std::num::NonZeroUsize;

let mut binary_heap = PopulatedBinaryHeap::with_capacity(NonZeroUsize::new(5).unwrap(), 1);
binary_heap.push(2);
binary_heap.push(3);
let (item, binary_heap) = binary_heap.pop();
assert_eq!(item, 3);
assert_eq!(binary_heap.len(), 2);

Source §

impl<T> PopulatedBinaryHeap<T>

Source

pub fn peek(&self) -> &T

Returns the greatest item in the populated binary heap.

use populated::PopulatedBinaryHeap;

let mut binary_heap = PopulatedBinaryHeap::new(1);
binary_heap.push(2);
binary_heap.push(3);
assert_eq!(binary_heap.peek(), &3);

Source

pub fn capacity(&self) -> NonZeroUsize

Returns the number of elements the binary heap can hold without reallocating.

use populated::PopulatedBinaryHeap;
use std::num::NonZeroUsize;

let binary_heap = PopulatedBinaryHeap::with_capacity(NonZeroUsize::new(10).unwrap(), 1);
assert_eq!(binary_heap.capacity(), NonZeroUsize::new(10).unwrap());

Source

pub fn shrink_to_fit(&mut self)

Discards as much additional capacity as possible. The capacity will never be less than the length.

Source

pub fn into_vec(self) -> PopulatedVec<T>

Consumes the PopulatedBinaryHeap and returns a populated vector with elements in arbitrary order.

use populated::PopulatedBinaryHeap;

let mut binary_heap = PopulatedBinaryHeap::new(1);
binary_heap.push(2);
binary_heap.push(3);
let vec = binary_heap.into_vec();
assert_eq!(vec.len().get(), 3);

Source

pub fn len(&self) -> NonZeroUsize

Returns the number of elements in the binary heap. Guaranteed to be non-zero.

use populated::PopulatedBinaryHeap;

let mut binary_heap = PopulatedBinaryHeap::new(1);
binary_heap.push(2);
binary_heap.push(3);
assert_eq!(binary_heap.len().get(), 3);

Source

pub fn clear(self) -> BinaryHeap<T>

Drops all items from the binary heap. Since the underlying binary heap is now empty, the return value is the underlying binary heap that that is empty but still allocated.

use populated::PopulatedBinaryHeap;
use std::num::NonZeroUsize;

let mut binary_heap = PopulatedBinaryHeap::with_capacity(NonZeroUsize::new(5).unwrap(), 1);
binary_heap.push(2);
binary_heap.push(3);
let binary_heap = binary_heap.clear();
assert_eq!(binary_heap.len(), 0);
assert_eq!(binary_heap.capacity(), 5);