Struct ic_stable_structures::min_heap::MinHeap

pub struct MinHeap<T: Storable + PartialOrd, M: Memory>(/* private fields */);

An implementation of the binary min heap.

Implementations

impl<T, M> MinHeap<T, M>

where T: Storable + PartialOrd, M: Memory,

pub fn new(memory: M) -> Result<Self, GrowFailed>

Creates a new empty heap in the specified memory, overwriting any data structures the memory might have contained.

Complexity: O(1)

pub fn init(memory: M) -> Result<Self, InitError>

Initializes a heap in the specified memory.

Complexity: O(1)

PRECONDITION: the memory is either empty or contains a valid stable heap.

pub fn len(&self) -> u64

Returns the number of items in the heap.

Complexity: O(1)

pub fn is_empty(&self) -> bool

Returns true if the heap is empty.

Complexity: O(1)

pub fn push(&mut self, item: &T) -> Result<(), GrowFailed>

Pushes an item onto the heap.

Complexity: O(log(self.len()))

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

Removes the smallest item from the heap and returns it. Returns None if the heap is empty.

Complexity: O(log(self.len()))

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

Returns the smallest item in the heap. Returns None if the heap is empty.

Complexity: O(1)

pub fn iter(&self) -> impl Iterator<Item = T> + '_

Returns an iterator visiting all values in the underlying vector, in arbitrary order.

pub fn into_memory(self) -> M

Returns the underlying memory instance.

Trait Implementations

impl<T, M> Debug for MinHeap<T, M>

where T: Storable + PartialOrd + Debug, M: Memory,

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.