Package org.tinspin.index.util

Class MinMaxHeap<T>

java.lang.Object

org.tinspin.index.util.MinMaxHeap<T>

Type Parameters:

T - Entry type

All Implemented Interfaces:

MinMaxHeapI<T>

public class MinMaxHeap<T>
extends Object
implements MinMaxHeapI<T>

Min-max heap implementation based on: https://en.wikipedia.org/wiki/Min-max_heap

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MinMaxHeap.Less<T>

Method Summary

Modifier and Type	Method	Description
void	clear()
static <T extends Comparable<T>> MinMaxHeap<T>	create()	WARNING: This is slow, see create(Less).
static <T> MinMaxHeap<T>	create(MinMaxHeap.Less<T> less)	Providing a less() method is the preferred way to use this MinMaxHeap.
static <T> MinMaxHeap<T>	createWithComparator(Comparator<T> compareFn)	WARNING: This is slow, see create(Less).
boolean	isEmpty()
T	peekMax()
T	peekMin()
void	popMax()
void	popMin()
String	print()
void	push(T value)
int	size()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static <T extends Comparable<T>> MinMaxHeap<T> create()

WARNING: This is slow, see create(Less). Creates a new MinMaxHeap using the compareTo method of the provided entry type.

Type Parameters:

T - The entry type. Must implement Comparable<T>.

Returns:

A new MinMaxHeap

createWithComparator

public static <T> MinMaxHeap<T> createWithComparator(Comparator<T> compareFn)

WARNING: This is slow, see create(Less). Creates a new MinMaxHeap using the provided comparator for entries.

Type Parameters:

T - The entry type.

Parameters:

compareFn - Comparator for T

Returns:

A new MinMaxHeap

create

public static <T> MinMaxHeap<T> create(MinMaxHeap.Less<T> less)

Providing a less() method is the preferred way to use this MinMaxHeap. Using less() is about 20% faster than using Comparator/Comparable.

Type Parameters:

T - The entry type.

Parameters:

less - A method that return `true` if the first parameter is less than the second

Returns:

A new MinMaxHeap

push

public void push(T value)

Specified by:

push in interface MinMaxHeapI<T>

popMin

public void popMin()

Specified by:

popMin in interface MinMaxHeapI<T>

popMax

public void popMax()

Specified by:

popMax in interface MinMaxHeapI<T>

peekMin

public T peekMin()

Specified by:

peekMin in interface MinMaxHeapI<T>

peekMax

public T peekMax()

Specified by:

peekMax in interface MinMaxHeapI<T>

size

public int size()

Specified by:

size in interface MinMaxHeapI<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface MinMaxHeapI<T>

print

public String print()

clear

public void clear()

Specified by:

clear in interface MinMaxHeapI<T>