heap

Documentation

Overview

Package heap implements generic heap functions.

Index

• func FixSlice[T any](x []T, index int, less func(x, y T) bool)
• func OrderSlice[T any](x []T, less func(x, y T) bool)
• func PopSlice[T any](x *[]T, less func(x, y T) bool) T
• func PushSlice[T any](x *[]T, item T, less func(x, y T) bool)

Functions

func FixSlice

func FixSlice[T any](x []T, index int, less func(x, y T) bool)

FixSlice fixes the element x[index] in order to preserve the min-heap invariant determined by the provided comparison function.

func OrderSlice

func OrderSlice[T any](x []T, less func(x, y T) bool)

OrderSlice shuffles x into min-heap ordering according to the provided comparison function. If len(x) > 0, the "smallest" element in x will always be x[0].

func PopSlice

func PopSlice[T any](x *[]T, less func(x, y T) bool) T

PopSlice removes the "smallest" element from x based on the provided comparison function and updates x appropriately to preserve the heap invariant.

func PushSlice

func PushSlice[T any](x *[]T, item T, less func(x, y T) bool)

PushSlice adds item to x while preserving the min-heap invariant determined by the provided comparison function.