heapq_test.go

package heapq_test

import (
	"cmp"
	"math/rand/v2"
	"sort"
	"testing"

	"github.com/creachadair/mds/compare"
	"github.com/creachadair/mds/heapq"
	"github.com/creachadair/mds/internal/mdtest"
	gocmp "github.com/google/go-cmp/cmp"
)

var _ mdtest.Shared[any] = (*heapq.Queue[any])(nil)

var intCompare = cmp.Compare[int]
var revIntCompare = compare.Reversed(cmp.Compare[int])

func TestHeap(t *testing.T) {
	t.Run("New", func(t *testing.T) {
		runTests(t, heapq.New(intCompare))
	})
	t.Run("NewWithData", func(t *testing.T) {
		buf := make([]int, 0, 64)
		runTests(t, heapq.NewWithData(intCompare, buf))
	})
}

func runTests(t *testing.T, q *heapq.Queue[int]) {
	t.Helper()

	check := func(want ...int) {
		t.Helper()
		var got []int
		for v := range q.Each {
			got = append(got, v)
		}
		if diff := gocmp.Diff(want, got); diff != "" {
			t.Errorf("Queue contents (+want, -got):\n%s", diff)
			t.Logf("Got:  %v", got)
			t.Logf("Want: %v", want)
		}
		if len(want) != 0 {
			if got := q.Front(); got != want[0] {
				t.Errorf("Front: got %v, want %v", got, want[0])
			}
		}
		if got := q.Len(); got != len(want) {
			t.Errorf("Len: got %v, want %v", got, len(want))
		}
	}
	checkAdd := func(v, want int) {
		if got := q.Add(v); got != want {
			t.Errorf("Add(%v): got %v, want %v", v, got, want)
		}
	}
	checkPop := func(want int, wantok bool) {
		got, ok := q.Pop()
		if got != want || ok != wantok {
			t.Errorf("Pop: got (%v, %v), want (%v, %v)", got, ok, want, wantok)
		}
	}
	checkRemove := func(n, want int, wantok bool) {
		got, ok := q.Remove(n)
		if got != want || ok != wantok {
			t.Errorf("Remove(%d): got (%v, %v), want (%v, %v)", n, got, ok, want, wantok)
		}
	}

	check()
	checkPop(0, false)

	checkAdd(10, 0)
	check(10)
	checkAdd(5, 0)
	check(5, 10)
	checkAdd(3, 0)
	check(3, 5, 10)
	checkAdd(4, 1)
	check(3, 4, 10, 5)
	checkPop(3, true)

	checkPop(4, true)
	checkPop(5, true)
	checkPop(10, true)
	checkPop(0, false)
	check()

	q.Set([]int{1, 2, 3, 4, 5})
	check(1, 2, 3, 4, 5)
	checkPop(1, true)

	q.Set([]int{1, 2, 3, 4, 5, 6})
	checkRemove(0, 1, true)
	checkRemove(2, 3, true)
	checkRemove(5, 0, false)

	q.Clear()
	check()

	q.Set([]int{15, 3, 9, 4, 8, 2, 11, 20, 11, 17, 1})
	check(1, 3, 2, 4, 8, 9, 11, 20, 11, 17, 15) // constructed by hand
	if got := extract(q); !sort.IntsAreSorted(got) {
		t.Errorf("Queue contents are out of order: %v", got)
	}
}

func TestOrder(t *testing.T) {
	const inputSize = 5000
	const inputRange = 100000

	makeInput := func() []int {
		input := make([]int, inputSize)
		for i := range input {
			input[i] = rand.IntN(inputRange) - (inputRange / 2)
		}
		return input
	}

	t.Run("Ascending", func(t *testing.T) {
		q := heapq.New(intCompare)
		q.Set(makeInput())
		if got := extract(q); !sort.IntsAreSorted(got) {
			t.Errorf("Queue contents are out of order: %v", got)
		}
	})

	t.Run("Descending", func(t *testing.T) {
		q := heapq.New(revIntCompare)
		q.Set(makeInput())
		got := extract(q)
		if !sort.IsSorted(sort.Reverse(sort.IntSlice(got))) {
			t.Errorf("Queue contents are out of order: %v", got)
		}
	})

	t.Run("Reorder", func(t *testing.T) {
		q := heapq.New(intCompare)
		q.Set([]int{17, 3, 11, 2, 7, 5, 13})
		if got, want := q.Front(), 2; got != want {
			t.Errorf("Front: got %v, want %v", got, want)
		}

		q.Reorder(revIntCompare)
		if got, want := q.Front(), 17; got != want {
			t.Errorf("Front: got %v, want %v", got, want)
		}

		got := extract(q)
		if !sort.IsSorted(sort.Reverse(sort.IntSlice(got))) {
			t.Errorf("Results are out of order: %v", got)
		}
	})
}

func TestNewWithData(t *testing.T) {
	const bufSize = 100 // N.B. must be even, so we can fill halves

	// Preallocate a buffer and populate part of it with some data.
	buf := make([]int, 0, bufSize)

	var want []int
	for range bufSize / 2 {
		z := rand.IntN(500) - 250
		buf = append(buf, z)
		want = append(want, z) // keep track of what we added.
	}

	// Give buf over to the queue, then add more stuff so we can check that the
	// queue took over the array correctly.
	q := heapq.NewWithData(intCompare, buf)

	// Add some more stuff via the queue.
	for range bufSize / 2 {
		z := rand.IntN(500) - 250
		q.Add(z)
		want = append(want, z)
	}

	// Check that the queue used the same array.  You are specifically NOT
	// supposed to do this, messing with the array outside the queue, but here
	// we need to check that the queue did the right thing.
	got := buf[:len(want)]
	sort.Ints(got)
	sort.Ints(want)

	if diff := gocmp.Diff(want, got); diff != "" {
		t.Errorf("Queue contents (+want, -got):\n%s", diff)
	}
}

func TestSort(t *testing.T) {
	longIn := make([]int, 50)
	for i := range longIn {
		longIn[i] = rand.IntN(1000) - 250
	}
	longOut := make([]int, len(longIn))
	copy(longOut, longIn)
	sort.Ints(longOut)

	lt := func(a, b int) int { return a - b }
	gt := func(a, b int) int { return b - a }
	_, _ = lt, gt
	tests := []struct {
		name        string
		cmp         func(a, b int) int
		input, want []int
	}{
		{"Nil", intCompare, nil, nil},
		{"Empty", intCompare, []int{}, nil},
		{"Single-LT", intCompare, []int{11}, []int{11}},
		{"Single-GT", revIntCompare, []int{11}, []int{11}},
		{"Ascend", intCompare, []int{9, 1, 4, 11}, []int{1, 4, 9, 11}},
		{"Descend", revIntCompare, []int{9, 1, 4, 11}, []int{11, 9, 4, 1}},
		{"Long", intCompare, longIn, longOut},
	}
	for _, tc := range tests {
		t.Run(tc.name, func(t *testing.T) {
			in := append([]int(nil), tc.input...)
			heapq.Sort(tc.cmp, in)
			if diff := gocmp.Diff(tc.want, in); diff != "" {
				t.Errorf("Sort (-want, +got):\n%s", diff)
			}
		})
	}
}

func TestUpdate(t *testing.T) {
	m := make(map[string]int)                // tracks the offsets of strings in the queue
	up := func(s string, p int) { m[s] = p } // update the offsets map
	q := heapq.New(cmp.Compare[string]).Update(up)

	// Verify that all the elements know their current offset correctly.
	check := func() {
		for i := 0; i < q.Len(); i++ {
			s, _ := q.Peek(i)
			if m[s] != i {
				t.Errorf("At pos %d: %s is at %d instead", i, s, m[s])
			}
		}
	}

	check() // empty

	// Check that Set assigns positions to the elements added.
	q.Set([]string{"m", "z", "t", "a", "k", "b"})
	check()

	// Check that Add updates positions correctly.
	q.Add("c")
	check()

	// Check that we can add an element and remove it by its assigned position.
	q.Add("j")
	check()

	oldp := m["j"]
	t.Logf("Added j at pos=%d", oldp)
	q.Remove(oldp)
	check()

	// After removal, the element retains its last position.
	if m["j"] != oldp {
		t.Errorf("After Remove j: p=%d, want %d", m["j"], oldp)
	}

	var got []string
	for !q.IsEmpty() {
		s, _ := q.Pop()
		got = append(got, s)
		if m[s] != 0 {
			t.Errorf("Pop: got %q at p=%d, want p=0", s, m[s])
		}

	}
	if diff := gocmp.Diff(got, []string{"a", "b", "c", "k", "m", "t", "z"}); diff != "" {
		t.Errorf("Values (-got, +want):\n%s", diff)
	}
}

func extract[T any](q *heapq.Queue[T]) []T {
	all := make([]T, 0, q.Len())
	for !q.IsEmpty() {
		all = append(all, q.Front())
		q.Pop()
	}
	return all
}