MinHeap (tinspin-indexes 2.1.2 API)

java.lang.Object
- org.tinspin.index.util.MinHeap<T>

Type Parameters:

T - Entry type

All Implemented Interfaces:

MinHeapI<T>
```
public class MinHeap<T>
extends Object
implements MinHeapI<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 MinHeap.Less<T>

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`
`static <T extends Comparable<T>> MinHeap<T>`	`create()`	WARNING: This is slow, see `create(Less)`.
`static <T> MinHeap<T>`	`create(MinHeap.Less<T> less)`	Providing a less() method is the preferred way to use this MinMaxHeap.
`boolean`	`isEmpty()`
`T`	`peekMin()`
`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>> MinHeap<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
  - create
```
public static <T> MinHeap<T> create(MinHeap.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 MinHeapI<T>
  - popMin
```
public void popMin()
```
    Specified by:
    
    popMin in interface MinHeapI<T>
  - peekMin
```
public T peekMin()
```
    Specified by:
    
    peekMin in interface MinHeapI<T>
  - size
```
public int size()
```
    Specified by:
    
    size in interface MinHeapI<T>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface MinHeapI<T>
  - print
```
public String print()
```
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface MinHeapI<T>