qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-19 15:05:00 -07:00
Code Releases Activity

sort: fix mix-up between "!less" and "greater" in examples

Browse Source 
If Less(a, b) returns true when a is less than b, the correct way to
check if a is greater than b is to use Less(b, a). It is wrong to use
!Less(a, b) because that checks if a is greater than *or equal to* b.

1. The decreasingDistance function in Example_sortKeys makes this
   mistake. Fix it.

2. The documentation of multiSorter.Less says it loops along the less
   functions until it finds a comparison "that is either Less or
   !Less". This is nonsense, because (Less(a, b) or !Less(a, b)) is
   always true. Fix the documentation to say that it finds a
   comparison "that discriminates between the two items (one is less
   than the other)". The implementation already does this correctly.

Change-Id: If52b79f68e4fdb0d1095edf29bdecdf154a61b8d
Reviewed-on: https://go-review.googlesource.com/57752
Reviewed-by: Ian Lance Taylor <iant@golang.org>
Run-TryBot: Ian Lance Taylor <iant@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
This commit is contained in:
Tom Levy 2017-08-22 17:10:46 +12:00 committed by Joe Tsai
parent aea286b449
commit 2bba267120
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/sort/example_keys_test.go
View File

@ -73,7 +73,7 @@ func Example_sortKeys() {
return p1.distance < p2.distance return p1.distance < p2.distance
} }
decreasingDistance := func(p1, p2 *Planet) bool { decreasingDistance := func(p1, p2 *Planet) bool {
return !distance(p1, p2) return distance(p2, p1)
} }
// Sort the planets by the various criteria. // Sort the planets by the various criteria.

9
src/sort/example_multi_test.go
View File

@ -49,10 +49,11 @@ func (ms *multiSorter) Swap(i, j int) {
} }
// Less is part of sort.Interface. It is implemented by looping along the // Less is part of sort.Interface. It is implemented by looping along the
// less functions until it finds a comparison that is either Less or // less functions until it finds a comparison that discriminates between
// !Less. Note that it can call the less functions twice per call. We // the two items (one is less than the other). Note that it can call the
// could change the functions to return -1, 0, 1 and reduce the // less functions twice per call. We could change the functions to return
// number of calls for greater efficiency: an exercise for the reader. // -1, 0, 1 and reduce the number of calls for greater efficiency: an
// exercise for the reader.
func (ms *multiSorter) Less(i, j int) bool { func (ms *multiSorter) Less(i, j int) bool {
p, q := &ms.changes[i], &ms.changes[j] p, q := &ms.changes[i], &ms.changes[j]
// Try all but the last comparison. // Try all but the last comparison.