summaryrefslogtreecommitdiffstats
path: root/src/cmp
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-16 19:19:13 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-16 19:19:13 +0000
commitccd992355df7192993c666236047820244914598 (patch)
treef00fea65147227b7743083c6148396f74cd66935 /src/cmp
parentInitial commit. (diff)
downloadgolang-1.21-ccd992355df7192993c666236047820244914598.tar.xz
golang-1.21-ccd992355df7192993c666236047820244914598.zip
Adding upstream version 1.21.8.upstream/1.21.8
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/cmp')
-rw-r--r--src/cmp/cmp.go59
-rw-r--r--src/cmp/cmp_test.go95
2 files changed, 154 insertions, 0 deletions
diff --git a/src/cmp/cmp.go b/src/cmp/cmp.go
new file mode 100644
index 0000000..0fba5c1
--- /dev/null
+++ b/src/cmp/cmp.go
@@ -0,0 +1,59 @@
+// Copyright 2023 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package cmp provides types and functions related to comparing
+// ordered values.
+package cmp
+
+// Ordered is a constraint that permits any ordered type: any type
+// that supports the operators < <= >= >.
+// If future releases of Go add new ordered types,
+// this constraint will be modified to include them.
+//
+// Note that floating-point types may contain NaN ("not-a-number") values.
+// An operator such as == or < will always report false when
+// comparing a NaN value with any other value, NaN or not.
+// See the [Compare] function for a consistent way to compare NaN values.
+type Ordered interface {
+ ~int | ~int8 | ~int16 | ~int32 | ~int64 |
+ ~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uintptr |
+ ~float32 | ~float64 |
+ ~string
+}
+
+// Less reports whether x is less than y.
+// For floating-point types, a NaN is considered less than any non-NaN,
+// and -0.0 is not less than (is equal to) 0.0.
+func Less[T Ordered](x, y T) bool {
+ return (isNaN(x) && !isNaN(y)) || x < y
+}
+
+// Compare returns
+//
+// -1 if x is less than y,
+// 0 if x equals y,
+// +1 if x is greater than y.
+//
+// For floating-point types, a NaN is considered less than any non-NaN,
+// a NaN is considered equal to a NaN, and -0.0 is equal to 0.0.
+func Compare[T Ordered](x, y T) int {
+ xNaN := isNaN(x)
+ yNaN := isNaN(y)
+ if xNaN && yNaN {
+ return 0
+ }
+ if xNaN || x < y {
+ return -1
+ }
+ if yNaN || x > y {
+ return +1
+ }
+ return 0
+}
+
+// isNaN reports whether x is a NaN without requiring the math package.
+// This will always return false if T is not floating-point.
+func isNaN[T Ordered](x T) bool {
+ return x != x
+}
diff --git a/src/cmp/cmp_test.go b/src/cmp/cmp_test.go
new file mode 100644
index 0000000..b0c0dc3
--- /dev/null
+++ b/src/cmp/cmp_test.go
@@ -0,0 +1,95 @@
+// Copyright 2023 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+package cmp_test
+
+import (
+ "cmp"
+ "math"
+ "sort"
+ "testing"
+)
+
+var negzero = math.Copysign(0, -1)
+
+var tests = []struct {
+ x, y any
+ compare int
+}{
+ {1, 2, -1},
+ {1, 1, 0},
+ {2, 1, +1},
+ {"a", "aa", -1},
+ {"a", "a", 0},
+ {"aa", "a", +1},
+ {1.0, 1.1, -1},
+ {1.1, 1.1, 0},
+ {1.1, 1.0, +1},
+ {math.Inf(1), math.Inf(1), 0},
+ {math.Inf(-1), math.Inf(-1), 0},
+ {math.Inf(-1), 1.0, -1},
+ {1.0, math.Inf(-1), +1},
+ {math.Inf(1), 1.0, +1},
+ {1.0, math.Inf(1), -1},
+ {math.NaN(), math.NaN(), 0},
+ {0.0, math.NaN(), +1},
+ {math.NaN(), 0.0, -1},
+ {math.NaN(), math.Inf(-1), -1},
+ {math.Inf(-1), math.NaN(), +1},
+ {0.0, 0.0, 0},
+ {negzero, negzero, 0},
+ {negzero, 0.0, 0},
+ {0.0, negzero, 0},
+ {negzero, 1.0, -1},
+ {negzero, -1.0, +1},
+}
+
+func TestLess(t *testing.T) {
+ for _, test := range tests {
+ var b bool
+ switch test.x.(type) {
+ case int:
+ b = cmp.Less(test.x.(int), test.y.(int))
+ case string:
+ b = cmp.Less(test.x.(string), test.y.(string))
+ case float64:
+ b = cmp.Less(test.x.(float64), test.y.(float64))
+ }
+ if b != (test.compare < 0) {
+ t.Errorf("Less(%v, %v) == %t, want %t", test.x, test.y, b, test.compare < 0)
+ }
+ }
+}
+
+func TestCompare(t *testing.T) {
+ for _, test := range tests {
+ var c int
+ switch test.x.(type) {
+ case int:
+ c = cmp.Compare(test.x.(int), test.y.(int))
+ case string:
+ c = cmp.Compare(test.x.(string), test.y.(string))
+ case float64:
+ c = cmp.Compare(test.x.(float64), test.y.(float64))
+ }
+ if c != test.compare {
+ t.Errorf("Compare(%v, %v) == %d, want %d", test.x, test.y, c, test.compare)
+ }
+ }
+}
+
+func TestSort(t *testing.T) {
+ // Test that our comparison function is consistent with
+ // sort.Float64s.
+ input := []float64{1.0, 0.0, negzero, math.Inf(1), math.Inf(-1), math.NaN()}
+ sort.Float64s(input)
+ for i := 0; i < len(input)-1; i++ {
+ if cmp.Less(input[i+1], input[i]) {
+ t.Errorf("Less sort mismatch at %d in %v", i, input)
+ }
+ if cmp.Compare(input[i], input[i+1]) > 0 {
+ t.Errorf("Compare sort mismatch at %d in %v", i, input)
+ }
+ }
+}