heaps

package

v0.2.1 Latest Latest Go to latest Published: Oct 24, 2023 License: MIT Imports: 1 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/fluhus/gostuff

Links

Open Source Insights

Documentation ¶

Overview ¶

Package heaps provides generic heaps.

This package provides better run speeds than the standard [heap] package.

Index ¶

type Heap

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Heap ¶

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

Heap is a generic heap.

func Max ¶

func Max[T constraints.Ordered]() *Heap[T]

Max returns a new max-heap of an ordered type by its natural order.

func Min ¶

func Min[T constraints.Ordered]() *Heap[T]

Min returns a new min-heap of an ordered type by its natural order.

func New ¶

func New[T any](less func(T, T) bool) *Heap[T]

New returns a new heap that uses the given comparator function.

func (*Heap[T]) Head ¶

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

Head returns the minimal element in h.

func (*Heap[T]) Len ¶

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

Len returns the number of elements in h.

func (*Heap[T]) Pop ¶

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

Pop removes and returns the minimal element in h.

func (*Heap[T]) Push ¶

func (h *Heap[T]) Push(x T)

Push adds x to h while maintaining its heap invariants.

func (*Heap[T]) PushSlice ¶ added in v0.1.13

func (h *Heap[T]) PushSlice(s []T)

PushSlice adds the elements of s to h while maintaining its heap invariants. The complexity is O(new n), so it should be typically used to initialize a new heap.

func (*Heap[T]) View ¶

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

View returns the underlying slice of h, containing all of its elements. Modifying the slice may invalidate the heap.

Source Files ¶

View all Source files

heaps.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL