1 // Copyright 2021 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
17 var equalIntTests = []struct {
43 var equalFloatTests = []struct {
55 []float64{1, 2, math.NaN()},
56 []float64{1, 2, math.NaN()},
62 func TestEqual(t *testing.T) {
63 for _, test := range equalIntTests {
64 if got := Equal(test.s1, test.s2); got != test.want {
65 t.Errorf("Equal(%v, %v) = %t, want %t", test.s1, test.s2, got, test.want)
68 for _, test := range equalFloatTests {
69 if got := Equal(test.s1, test.s2); got != test.wantEqual {
70 t.Errorf("Equal(%v, %v) = %t, want %t", test.s1, test.s2, got, test.wantEqual)
75 // equal is simply ==.
76 func equal[T comparable](v1, v2 T) bool {
80 // equalNaN is like == except that all NaNs are equal.
81 func equalNaN[T comparable](v1, v2 T) bool {
82 isNaN := func(f T) bool { return f != f }
83 return v1 == v2 || (isNaN(v1) && isNaN(v2))
86 // offByOne returns true if integers v1 and v2 differ by 1.
87 func offByOne(v1, v2 int) bool {
88 return v1 == v2+1 || v1 == v2-1
91 func TestEqualFunc(t *testing.T) {
92 for _, test := range equalIntTests {
93 if got := EqualFunc(test.s1, test.s2, equal[int]); got != test.want {
94 t.Errorf("EqualFunc(%v, %v, equal[int]) = %t, want %t", test.s1, test.s2, got, test.want)
97 for _, test := range equalFloatTests {
98 if got := EqualFunc(test.s1, test.s2, equal[float64]); got != test.wantEqual {
99 t.Errorf("Equal(%v, %v, equal[float64]) = %t, want %t", test.s1, test.s2, got, test.wantEqual)
101 if got := EqualFunc(test.s1, test.s2, equalNaN[float64]); got != test.wantEqualNaN {
102 t.Errorf("Equal(%v, %v, equalNaN[float64]) = %t, want %t", test.s1, test.s2, got, test.wantEqualNaN)
108 if EqualFunc(s1, s1, offByOne) {
109 t.Errorf("EqualFunc(%v, %v, offByOne) = true, want false", s1, s1)
111 if !EqualFunc(s1, s2, offByOne) {
112 t.Errorf("EqualFunc(%v, %v, offByOne) = false, want true", s1, s2)
115 s3 := []string{"a", "b", "c"}
116 s4 := []string{"A", "B", "C"}
117 if !EqualFunc(s3, s4, strings.EqualFold) {
118 t.Errorf("EqualFunc(%v, %v, strings.EqualFold) = false, want true", s3, s4)
121 cmpIntString := func(v1 int, v2 string) bool {
122 return string(rune(v1)-1+'a') == v2
124 if !EqualFunc(s1, s3, cmpIntString) {
125 t.Errorf("EqualFunc(%v, %v, cmpIntString) = false, want true", s1, s3)
129 func BenchmarkEqualFunc_Large(b *testing.B) {
130 type Large [4 * 1024]byte
132 xs := make([]Large, 1024)
133 ys := make([]Large, 1024)
134 for i := 0; i < b.N; i++ {
135 _ = EqualFunc(xs, ys, func(x, y Large) bool { return x == y })
139 var compareIntTests = []struct {
190 []int{1, 2, 3, 8, 9},
195 var compareFloatTests = []struct {
210 []float64{math.NaN()},
211 []float64{math.NaN()},
215 []float64{1, 2, math.NaN()},
216 []float64{1, 2, math.NaN()},
220 []float64{1, math.NaN(), 3},
221 []float64{1, math.NaN(), 4},
225 []float64{1, math.NaN(), 3},
230 []float64{1, math.NaN(), 3},
231 []float64{1, 2, math.NaN()},
236 []float64{1, 2, math.NaN()},
241 []float64{1, math.NaN(), 3},
245 []float64{1, math.NaN(), 3, 4},
246 []float64{1, 2, math.NaN()},
251 func TestCompare(t *testing.T) {
252 intWant := func(want bool) string {
258 for _, test := range equalIntTests {
259 if got := Compare(test.s1, test.s2); (got == 0) != test.want {
260 t.Errorf("Compare(%v, %v) = %d, want %s", test.s1, test.s2, got, intWant(test.want))
263 for _, test := range equalFloatTests {
264 if got := Compare(test.s1, test.s2); (got == 0) != test.wantEqualNaN {
265 t.Errorf("Compare(%v, %v) = %d, want %s", test.s1, test.s2, got, intWant(test.wantEqualNaN))
269 for _, test := range compareIntTests {
270 if got := Compare(test.s1, test.s2); got != test.want {
271 t.Errorf("Compare(%v, %v) = %d, want %d", test.s1, test.s2, got, test.want)
274 for _, test := range compareFloatTests {
275 if got := Compare(test.s1, test.s2); got != test.want {
276 t.Errorf("Compare(%v, %v) = %d, want %d", test.s1, test.s2, got, test.want)
281 func equalToCmp[T comparable](eq func(T, T) bool) func(T, T) int {
282 return func(v1, v2 T) int {
290 func TestCompareFunc(t *testing.T) {
291 intWant := func(want bool) string {
297 for _, test := range equalIntTests {
298 if got := CompareFunc(test.s1, test.s2, equalToCmp(equal[int])); (got == 0) != test.want {
299 t.Errorf("CompareFunc(%v, %v, equalToCmp(equal[int])) = %d, want %s", test.s1, test.s2, got, intWant(test.want))
302 for _, test := range equalFloatTests {
303 if got := CompareFunc(test.s1, test.s2, equalToCmp(equal[float64])); (got == 0) != test.wantEqual {
304 t.Errorf("CompareFunc(%v, %v, equalToCmp(equal[float64])) = %d, want %s", test.s1, test.s2, got, intWant(test.wantEqual))
308 for _, test := range compareIntTests {
309 if got := CompareFunc(test.s1, test.s2, cmp.Compare[int]); got != test.want {
310 t.Errorf("CompareFunc(%v, %v, cmp[int]) = %d, want %d", test.s1, test.s2, got, test.want)
313 for _, test := range compareFloatTests {
314 if got := CompareFunc(test.s1, test.s2, cmp.Compare[float64]); got != test.want {
315 t.Errorf("CompareFunc(%v, %v, cmp[float64]) = %d, want %d", test.s1, test.s2, got, test.want)
321 if got := CompareFunc(s1, s2, equalToCmp(offByOne)); got != 0 {
322 t.Errorf("CompareFunc(%v, %v, offByOne) = %d, want 0", s1, s2, got)
325 s3 := []string{"a", "b", "c"}
326 s4 := []string{"A", "B", "C"}
327 if got := CompareFunc(s3, s4, strings.Compare); got != 1 {
328 t.Errorf("CompareFunc(%v, %v, strings.Compare) = %d, want 1", s3, s4, got)
331 compareLower := func(v1, v2 string) int {
332 return strings.Compare(strings.ToLower(v1), strings.ToLower(v2))
334 if got := CompareFunc(s3, s4, compareLower); got != 0 {
335 t.Errorf("CompareFunc(%v, %v, compareLower) = %d, want 0", s3, s4, got)
338 cmpIntString := func(v1 int, v2 string) int {
339 return strings.Compare(string(rune(v1)-1+'a'), v2)
341 if got := CompareFunc(s1, s3, cmpIntString); got != 0 {
342 t.Errorf("CompareFunc(%v, %v, cmpIntString) = %d, want 0", s1, s3, got)
346 var indexTests = []struct {
378 func TestIndex(t *testing.T) {
379 for _, test := range indexTests {
380 if got := Index(test.s, test.v); got != test.want {
381 t.Errorf("Index(%v, %v) = %d, want %d", test.s, test.v, got, test.want)
386 func equalToIndex[T any](f func(T, T) bool, v1 T) func(T) bool {
387 return func(v2 T) bool {
392 func BenchmarkIndex_Large(b *testing.B) {
393 type Large [4 * 1024]byte
395 ss := make([]Large, 1024)
396 for i := 0; i < b.N; i++ {
397 _ = Index(ss, Large{1})
401 func TestIndexFunc(t *testing.T) {
402 for _, test := range indexTests {
403 if got := IndexFunc(test.s, equalToIndex(equal[int], test.v)); got != test.want {
404 t.Errorf("IndexFunc(%v, equalToIndex(equal[int], %v)) = %d, want %d", test.s, test.v, got, test.want)
408 s1 := []string{"hi", "HI"}
409 if got := IndexFunc(s1, equalToIndex(equal[string], "HI")); got != 1 {
410 t.Errorf("IndexFunc(%v, equalToIndex(equal[string], %q)) = %d, want %d", s1, "HI", got, 1)
412 if got := IndexFunc(s1, equalToIndex(strings.EqualFold, "HI")); got != 0 {
413 t.Errorf("IndexFunc(%v, equalToIndex(strings.EqualFold, %q)) = %d, want %d", s1, "HI", got, 0)
417 func BenchmarkIndexFunc_Large(b *testing.B) {
418 type Large [4 * 1024]byte
420 ss := make([]Large, 1024)
421 for i := 0; i < b.N; i++ {
422 _ = IndexFunc(ss, func(e Large) bool {
428 func TestContains(t *testing.T) {
429 for _, test := range indexTests {
430 if got := Contains(test.s, test.v); got != (test.want != -1) {
431 t.Errorf("Contains(%v, %v) = %t, want %t", test.s, test.v, got, test.want != -1)
436 func TestContainsFunc(t *testing.T) {
437 for _, test := range indexTests {
438 if got := ContainsFunc(test.s, equalToIndex(equal[int], test.v)); got != (test.want != -1) {
439 t.Errorf("ContainsFunc(%v, equalToIndex(equal[int], %v)) = %t, want %t", test.s, test.v, got, test.want != -1)
443 s1 := []string{"hi", "HI"}
444 if got := ContainsFunc(s1, equalToIndex(equal[string], "HI")); got != true {
445 t.Errorf("ContainsFunc(%v, equalToContains(equal[string], %q)) = %t, want %t", s1, "HI", got, true)
447 if got := ContainsFunc(s1, equalToIndex(equal[string], "hI")); got != false {
448 t.Errorf("ContainsFunc(%v, equalToContains(strings.EqualFold, %q)) = %t, want %t", s1, "hI", got, false)
450 if got := ContainsFunc(s1, equalToIndex(strings.EqualFold, "hI")); got != true {
451 t.Errorf("ContainsFunc(%v, equalToContains(strings.EqualFold, %q)) = %t, want %t", s1, "hI", got, true)
455 var insertTests = []struct {
483 []int{1, 2, 4, 5, 3},
487 func TestInsert(t *testing.T) {
489 if got := Insert(s, 0); !Equal(got, s) {
490 t.Errorf("Insert(%v, 0) = %v, want %v", s, got, s)
492 for _, test := range insertTests {
493 copy := Clone(test.s)
494 if got := Insert(copy, test.i, test.add...); !Equal(got, test.want) {
495 t.Errorf("Insert(%v, %d, %v...) = %v, want %v", test.s, test.i, test.add, got, test.want)
499 if !testenv.OptimizationOff() && !race.Enabled {
500 // Allocations should be amortized.
502 n := testing.AllocsPerRun(10, func() {
504 for i := 0; i < count; i++ {
509 t.Errorf("too many allocations inserting %d elements: got %v, want less than %d", count, n, count/2)
514 func TestInsertOverlap(t *testing.T) {
517 want := make([]int, 2*N)
518 for n := 0; n <= N; n++ { // length
519 for i := 0; i <= n; i++ { // insertion point
520 for x := 0; x <= N; x++ { // start of inserted data
521 for y := x; y <= N; y++ { // end of inserted data
522 for k := 0; k < N; k++ {
526 want = append(want, a[:i]...)
527 want = append(want, a[x:y]...)
528 want = append(want, a[i:n]...)
529 got := Insert(a[:n], i, a[x:y]...)
530 if !Equal(got, want) {
531 t.Errorf("Insert with overlap failed n=%d i=%d x=%d y=%d, got %v want %v", n, i, x, y, got, want)
539 var deleteTests = []struct {
576 func TestDelete(t *testing.T) {
577 for _, test := range deleteTests {
578 copy := Clone(test.s)
579 if got := Delete(copy, test.i, test.j); !Equal(got, test.want) {
580 t.Errorf("Delete(%v, %d, %d) = %v, want %v", test.s, test.i, test.j, got, test.want)
585 var deleteFuncTests = []struct {
592 func(int) bool { return true },
597 func(int) bool { return true },
602 func(int) bool { return false },
607 func(i int) bool { return i > 2 },
612 func(i int) bool { return i < 2 },
617 func(i int) bool { return i >= 10 },
622 func TestDeleteFunc(t *testing.T) {
623 for i, test := range deleteFuncTests {
624 copy := Clone(test.s)
625 if got := DeleteFunc(copy, test.fn); !Equal(got, test.want) {
626 t.Errorf("DeleteFunc case %d: got %v, want %v", i, got, test.want)
631 func panics(f func()) (b bool) {
633 if x := recover(); x != nil {
641 func TestDeletePanics(t *testing.T) {
642 for _, test := range []struct {
647 {"with negative first index", []int{42}, -2, 1},
648 {"with negative second index", []int{42}, 1, -1},
649 {"with out-of-bounds first index", []int{42}, 2, 3},
650 {"with out-of-bounds second index", []int{42}, 0, 2},
651 {"with invalid i>j", []int{42}, 1, 0},
653 if !panics(func() { Delete(test.s, test.i, test.j) }) {
654 t.Errorf("Delete %s: got no panic, want panic", test.name)
659 func TestClone(t *testing.T) {
663 t.Errorf("Clone(%v) = %v, want %v", s1, s2, s1)
666 want := []int{1, 2, 3}
667 if !Equal(s2, want) {
668 t.Errorf("Clone(%v) changed unexpectedly to %v", want, s2)
670 if got := Clone([]int(nil)); got != nil {
671 t.Errorf("Clone(nil) = %#v, want nil", got)
673 if got := Clone(s1[:0]); got == nil || len(got) != 0 {
674 t.Errorf("Clone(%v) = %#v, want %#v", s1[:0], got, s1[:0])
678 var compactTests = []struct {
710 []int{1, 2, 2, 3, 3, 4},
715 func TestCompact(t *testing.T) {
716 for _, test := range compactTests {
717 copy := Clone(test.s)
718 if got := Compact(copy); !Equal(got, test.want) {
719 t.Errorf("Compact(%v) = %v, want %v", test.s, got, test.want)
724 func BenchmarkCompact(b *testing.B) {
725 for _, c := range compactTests {
726 b.Run(c.name, func(b *testing.B) {
727 ss := make([]int, 0, 64)
728 for k := 0; k < b.N; k++ {
730 ss = append(ss, c.s...)
737 func BenchmarkCompact_Large(b *testing.B) {
738 type Large [4 * 1024]byte
740 ss := make([]Large, 1024)
741 for i := 0; i < b.N; i++ {
746 func TestCompactFunc(t *testing.T) {
747 for _, test := range compactTests {
748 copy := Clone(test.s)
749 if got := CompactFunc(copy, equal[int]); !Equal(got, test.want) {
750 t.Errorf("CompactFunc(%v, equal[int]) = %v, want %v", test.s, got, test.want)
754 s1 := []string{"a", "a", "A", "B", "b"}
756 want := []string{"a", "B"}
757 if got := CompactFunc(copy, strings.EqualFold); !Equal(got, want) {
758 t.Errorf("CompactFunc(%v, strings.EqualFold) = %v, want %v", s1, got, want)
762 func BenchmarkCompactFunc_Large(b *testing.B) {
763 type Large [4 * 1024]byte
765 ss := make([]Large, 1024)
766 for i := 0; i < b.N; i++ {
767 _ = CompactFunc(ss, func(a, b Large) bool { return a == b })
771 func TestGrow(t *testing.T) {
775 s2 := Grow(copy, 1000)
777 t.Errorf("Grow(%v) = %v, want %v", s1, s2, s1)
779 if cap(s2) < 1000+len(s1) {
780 t.Errorf("after Grow(%v) cap = %d, want >= %d", s1, cap(s2), 1000+len(s1))
783 // Test mutation of elements between length and capacity.
785 s3 := Grow(copy[:1], 2)[:3]
787 t.Errorf("Grow should not mutate elements between length and capacity")
789 s3 = Grow(copy[:1], 1000)[:3]
791 t.Errorf("Grow should not mutate elements between length and capacity")
794 // Test number of allocations.
795 if n := testing.AllocsPerRun(100, func() { Grow(s2, cap(s2)-len(s2)) }); n != 0 {
796 t.Errorf("Grow should not allocate when given sufficient capacity; allocated %v times", n)
798 if n := testing.AllocsPerRun(100, func() { Grow(s2, cap(s2)-len(s2)+1) }); n != 1 {
800 if race.Enabled || testenv.OptimizationOff() {
801 errorf = t.Logf // this allocates multiple times in race detector mode
803 errorf("Grow should allocate once when given insufficient capacity; allocated %v times", n)
806 // Test for negative growth sizes.
809 defer func() { gotPanic = recover() != nil }()
813 t.Errorf("Grow(-1) did not panic; expected a panic")
817 func TestClip(t *testing.T) {
818 s1 := []int{1, 2, 3, 4, 5, 6}[:3]
821 t.Errorf("len(%v) = %d, want 3", s1, len(s1))
824 t.Errorf("cap(%v[:3]) = %d, want >= 6", orig, cap(s1))
828 t.Errorf("Clip(%v) = %v, want %v", s1, s2, s1)
831 t.Errorf("cap(Clip(%v)) = %d, want 3", orig, cap(s2))
835 func TestReverse(t *testing.T) {
836 even := []int{3, 1, 4, 1, 5, 9} // len = 6
838 if want := []int{9, 5, 1, 4, 1, 3}; !Equal(even, want) {
839 t.Errorf("Reverse(even) = %v, want %v", even, want)
842 odd := []int{3, 1, 4, 1, 5, 9, 2} // len = 7
844 if want := []int{2, 9, 5, 1, 4, 1, 3}; !Equal(odd, want) {
845 t.Errorf("Reverse(odd) = %v, want %v", odd, want)
848 words := strings.Fields("one two three")
850 if want := strings.Fields("three two one"); !Equal(words, want) {
851 t.Errorf("Reverse(words) = %v, want %v", words, want)
854 singleton := []string{"one"}
856 if want := []string{"one"}; !Equal(singleton, want) {
857 t.Errorf("Reverse(singeleton) = %v, want %v", singleton, want)
860 Reverse[[]string](nil)
863 // naiveReplace is a baseline implementation to the Replace function.
864 func naiveReplace[S ~[]E, E any](s S, i, j int, v ...E) S {
866 s = Insert(s, i, v...)
870 func TestReplace(t *testing.T) {
871 for _, test := range []struct {
875 {}, // all zero value
877 s: []int{1, 2, 3, 4},
883 s: []int{1, 2, 3, 4},
884 v: []int{5, 6, 7, 8},
890 s := make([]int, 3, 20)
896 v: []int{3, 4, 5, 6, 7},
901 ss, vv := Clone(test.s), Clone(test.v)
902 want := naiveReplace(ss, test.i, test.j, vv...)
903 got := Replace(test.s, test.i, test.j, test.v...)
904 if !Equal(got, want) {
905 t.Errorf("Replace(%v, %v, %v, %v) = %v, want %v", test.s, test.i, test.j, test.v, got, want)
910 func TestReplacePanics(t *testing.T) {
911 for _, test := range []struct {
916 {"indexes out of order", []int{1, 2}, []int{3}, 2, 1},
917 {"large index", []int{1, 2}, []int{3}, 1, 10},
918 {"negative index", []int{1, 2}, []int{3}, -1, 2},
920 ss, vv := Clone(test.s), Clone(test.v)
921 if !panics(func() { Replace(ss, test.i, test.j, vv...) }) {
922 t.Errorf("Replace %s: should have panicked", test.name)
927 func TestReplaceOverlap(t *testing.T) {
930 want := make([]int, 2*N)
931 for n := 0; n <= N; n++ { // length
932 for i := 0; i <= n; i++ { // insertion point 1
933 for j := i; j <= n; j++ { // insertion point 2
934 for x := 0; x <= N; x++ { // start of inserted data
935 for y := x; y <= N; y++ { // end of inserted data
936 for k := 0; k < N; k++ {
940 want = append(want, a[:i]...)
941 want = append(want, a[x:y]...)
942 want = append(want, a[j:n]...)
943 got := Replace(a[:n], i, j, a[x:y]...)
944 if !Equal(got, want) {
945 t.Errorf("Insert with overlap failed n=%d i=%d j=%d x=%d y=%d, got %v want %v", n, i, j, x, y, got, want)
954 func BenchmarkReplace(b *testing.B) {
963 return make([]int, 100)
966 return make([]int, 20)
974 return make([]int, 100)
977 return make([]int, 20)
984 for _, c := range cases {
985 b.Run("naive-"+c.name, func(b *testing.B) {
986 for k := 0; k < b.N; k++ {
989 _ = naiveReplace(s, c.i, c.j, v...)
992 b.Run("optimized-"+c.name, func(b *testing.B) {
993 for k := 0; k < b.N; k++ {
996 _ = Replace(s, c.i, c.j, v...)
1003 func TestInsertGrowthRate(t *testing.T) {
1004 b := make([]byte, 1)
1008 for i := 0; i < N; i++ {
1009 b = Insert(b, len(b)-1, 0)
1010 if cap(b) > maxCap {
1015 want := int(math.Log(N) / math.Log(1.25)) // 1.25 == growth rate for large slices
1017 t.Errorf("too many grows. got:%d want:%d", nGrow, want)
1021 func TestReplaceGrowthRate(t *testing.T) {
1022 b := make([]byte, 2)
1026 for i := 0; i < N; i++ {
1027 b = Replace(b, len(b)-2, len(b)-1, 0, 0)
1028 if cap(b) > maxCap {
1033 want := int(math.Log(N) / math.Log(1.25)) // 1.25 == growth rate for large slices
1035 t.Errorf("too many grows. got:%d want:%d", nGrow, want)
1039 func apply[T any](v T, f func(T)) {
1043 // Test type inference with a named slice type.
1044 func TestInference(t *testing.T) {
1045 s1 := []int{1, 2, 3}
1047 if want := []int{3, 2, 1}; !Equal(s1, want) {
1048 t.Errorf("Reverse(%v) = %v, want %v", []int{1, 2, 3}, s1, want)
1054 if want := (S{6, 5, 4}); !Equal(s2, want) {
1055 t.Errorf("Reverse(%v) = %v, want %v", S{4, 5, 6}, s2, want)