Struct HeapType

pub struct HeapType<T, E>
where
    T: Heap<E>,
{
    pub data: T,
    /* private fields */
}

A heap structure which holds a type which derives from Heap

Fields

data: T

Implementations

impl<T: Heap<E>, E> HeapType<T, E>

pub fn new(init: T) -> HeapType<T, E>

where T: Heap<E>,

Initialized a new heap from a Heap type

Arguments

• init: The Heap type to be initialized

returns: HeapType<T, E> which is your heap data structure

Examples

use go_heap_rs::{HeapType, MinHeap};

let my_vec = MinHeap(vec![4, 3, 2, 1]); // see min heap implementation in Heap trait
let mut heap = HeapType::new(my_vec);
assert_eq!(heap.peak(), Some(&1));

pub fn push(&mut self, x: E)

Pushes an element into heap

Arguments

• x: The element to push it into heap

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

Removes the greatest item from the binary heap and returns it, or None if it is empty.

returns E: The first element in list

pub fn remove(&mut self, i: usize) -> E

Removes an element from heap by it’s index in it’s underlying container

Arguments

• i: The index to remove

returns E: The element which as been removed

Panics

This method might panic (based on implementation of swap) if i is bigger than len()

Examples

use go_heap_rs::{HeapType, MinHeap};

let my_vec = MinHeap(vec![1, 4, 3]);
let mut heap = HeapType::new(my_vec); // [1, 4, 3]
assert_eq!(heap.remove(1), 4);
assert_eq!(heap.pop(), Some(1));
assert_eq!(heap.pop(), Some(3));
assert_eq!(heap.pop(), None);

pub fn fix(&mut self, i: usize)

Fix re-establishes the heap ordering after the element at index i has changed its value. Changing the value of the element at index i and then calling Fix is equivalent to, but less expensive than, calling Remove(h, i) followed by a Push of the new value.

Arguments

• i: The index to fix

Examples

use go_heap_rs::{HeapType, MinHeap};

let my_vec = MinHeap(vec![10, 4, 3]);
let mut heap = HeapType::new(my_vec); // [3, 4, 10]
heap.data.0[1] = 0;
heap.fix(0);
assert_eq!(heap.pop(), Some(0));
assert_eq!(heap.pop(), Some(3));
assert_eq!(heap.pop(), Some(10));
assert_eq!(heap.pop(), None);

pub fn peak(&self) -> Option<&E>

peak will return the top of heap if available

pub fn len(&self) -> usize

len will simply call self.data.len()