Skip to content

Commit

Permalink
feat: copy cmp from go1.21
Browse files Browse the repository at this point in the history
  • Loading branch information
stackcats authored and liyiheng committed Dec 11, 2023
1 parent 18a45bd commit 1388226
Show file tree
Hide file tree
Showing 5 changed files with 158 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
.idea
zset
.DS_Store
.tool-versions
59 changes: 59 additions & 0 deletions cmp/cmp.go
Original file line number Diff line number Diff line change
@@ -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
}
95 changes: 95 additions & 0 deletions cmp/cmp_test.go
Original file line number Diff line number Diff line change
@@ -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 (
"github.com/liyiheng/zset/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)
}
}
}
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module github.com/liyiheng/zset

go 1.21
go 1.18
2 changes: 1 addition & 1 deletion zset.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
package zset

import (
"cmp"
"github.com/liyiheng/zset/cmp"
"math/rand"
)

Expand Down

0 comments on commit 1388226

Please sign in to comment.