heap

package

v0.1.0 Latest Latest Go to latest Published: Sep 5, 2023 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package heap provides an implementation of heap data structure in Go.

This section is empty.

This section is empty.

This section is empty.

type Element[T any] struct {
	Value T
	// contains filtered or unexported fields
}

Element is an element in the heap.

type Heap[T comparable] struct {
	// contains filtered or unexported fields
}

Heap represents a heap.

func New[T cmp.Ordered]() *Heap[T]

New creates a new heap of T.

func NewFunc[T comparable](less algorithm.LessFunc[T]) *Heap[T]

NewFunc creates a new heap of T using less.

func (h *Heap[T]) Fix(e *Element[T])

Fix fixes the position of value in the heap data structure. It should be called after its data changes.

func (h *Heap[T]) Len() int

Size returns the size of the queue.

func (h *Heap[T]) Pop() T

Pop pops a value from the heap.

func (h *Heap[T]) Push(value T) *Element[T]

Push pushes a value into the heap. It returns the created element for the provided value.

func (h *Heap[T]) Top() *Element[T]

Top returns the element at the top of the heap.