package binaryheap

Import Path
	github.com/emirpasic/gods/trees/binaryheap (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	   d➜ binaryheap.go
		Package binaryheap implements a binary heap backed by array list.

		Comparator defines this heap as either min or max heap.

		Structure is not thread safe.

		References: http://en.wikipedia.org/wiki/Binary_heap

	      iterator.go
	      serialization.go
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Heap (struct)
		Heap holds elements in an array-list

		Fields (total 2, in which 1 are exported)
			Comparator utils.Comparator
			/* one unexported ... *//* one unexported: */
			list *arraylist.List
		Methods (total 15, in which 11 are exported)
			(*T) Clear()
				Clear removes all elements from the heap.

			(*T) Empty() bool
				Empty returns true if heap does not contain any elements.

			(*T) FromJSON(data []byte) error
				FromJSON populates the heap from the input JSON representation.

			(*T) Iterator() Iterator
				Iterator returns a stateful iterator whose values can be fetched by an index.

			(*T) Peek() (value interface{}, ok bool)
				Peek returns top element on the heap without removing it, or nil if heap is empty.
				Second return parameter is true, unless the heap was empty and there was nothing to peek.

			(*T) Pop() (value interface{}, ok bool)
				Pop removes top element on heap and returns it, or nil if heap is empty.
				Second return parameter is true, unless the heap was empty and there was nothing to pop.

			(*T) Push(values ...interface{})
				Push adds a value onto the heap and bubbles it up accordingly.

			(*T) Size() int
				Size returns number of elements within the heap.

			(*T) String() string
				String returns a string representation of container

			(*T) ToJSON() ([]byte, error)
				ToJSON outputs the JSON representation of the heap.

			(*T) Values() []interface{}
				Values returns all elements in the heap.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*T) bubbleDown()
				Performs the "bubble down" operation. This is to place the element that is at the root
				of the heap in its correct place so that the heap maintains the min/max-heap order property.

			(*T) bubbleDownIndex(index int)
				Performs the "bubble down" operation. This is to place the element that is at the index
				of the heap in its correct place so that the heap maintains the min/max-heap order property.

			(*T) bubbleUp()
				Performs the "bubble up" operation. This is to place a newly inserted
				element (i.e. last element in the list) in its correct place so that
				the heap maintains the min/max-heap order property.

			(*T) withinRange(index int) bool
				Check that the index is within bounds of the list

		Implements (at least 8, in which 6 are exported)
			*T : github.com/emirpasic/gods/trees.Tree
			*T : github.com/emirpasic/gods/containers.Container
			*T : github.com/emirpasic/gods/containers.JSONDeserializer
			*T : github.com/emirpasic/gods/containers.JSONSerializer
			*T : expvar.Var
			*T : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least 3, all are exported)
			func NewWith(comparator utils.Comparator) *Heap
			func NewWithIntComparator() *Heap
			func NewWithStringComparator() *Heap

	 type Iterator (struct)
		Iterator returns a stateful iterator whose values can be fetched by an index.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			heap *Heap
			index int
		Methods (total 8, all are exported)
			(*T) Begin()
				Begin resets the iterator to its initial state (one-before-first)
				Call Next() to fetch the first element if any.

			(*T) End()
				End moves the iterator past the last element (one-past-the-end).
				Call Prev() to fetch the last element if any.

			(*T) First() bool
				First moves the iterator to the first element and returns true if there was a first element in the container.
				If First() returns true, then first element's index and value can be retrieved by Index() and Value().
				Modifies the state of the iterator.

			(*T) Index() int
				Index returns the current element's index.
				Does not modify the state of the iterator.

			(*T) Last() bool
				Last moves the iterator to the last element and returns true if there was a last element in the container.
				If Last() returns true, then last element's index and value can be retrieved by Index() and Value().
				Modifies the state of the iterator.

			(*T) Next() bool
				Next moves the iterator to the next element and returns true if there was a next element in the container.
				If Next() returns true, then next element's index and value can be retrieved by Index() and Value().
				If Next() was called for the first time, then it will point the iterator to the first element if it exists.
				Modifies the state of the iterator.

			(*T) Prev() bool
				Prev moves the iterator to the previous element and returns true if there was a previous element in the container.
				If Prev() returns true, then previous element's index and value can be retrieved by Index() and Value().
				Modifies the state of the iterator.

			(*T) Value() interface{}
				Value returns the current element's value.
				Does not modify the state of the iterator.

		Implements (at least 2, both are exported)
			*T : github.com/emirpasic/gods/containers.IteratorWithIndex
			*T : github.com/emirpasic/gods/containers.ReverseIteratorWithIndex
		As Outputs Of (at least one exported)
			func (*Heap).Iterator() Iterator


Package-Level Functions (total 6, in which 3 are exported)

	 func NewWith(comparator utils.Comparator) *Heap
		NewWith instantiates a new empty heap tree with the custom comparator.

	 func NewWithIntComparator() *Heap
		NewWithIntComparator instantiates a new empty heap with the IntComparator, i.e. elements are of type int.

	 func NewWithStringComparator() *Heap
		NewWithStringComparator instantiates a new empty heap with the StringComparator, i.e. elements are of type string.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func assertIteratorImplementation()
	 func assertSerializationImplementation()
	 func assertTreeImplementation()

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.