Merge pull request #7 from yourbasic/tip

Tip

README.md

@@ -1,4 +1,4 @@
-# Your basic bit
+# Your basic bit [![GoDoc](https://godoc.org/github.com/yourbasic/bit?status.svg)][godoc-bit]
 
 ### Golang set data structure with bonus bit-twiddling functions
 

bench_test.go

@@ -2,24 +2,6 @@ package bit
 
 import "testing"
 
-func BenchmarkLeadingZeros(b *testing.B) {
-	for i := 0; i < b.N; i++ {
-		LeadingZeros(0xcafecafecafecafe)
-	}
-}
-
-func BenchmarkTrailingZeros(b *testing.B) {
-	for i := 0; i < b.N; i++ {
-		TrailingZeros(0xcafecafecafecafe)
-	}
-}
-
-func BenchmarkCount(b *testing.B) {
-	for i := 0; i < b.N; i++ {
-		Count(0xcafecafecafecafe)
-	}
-}
-
 // Number of words in test set.
 const nw = 1 << 10
 

funcs.go

@@ -14,6 +14,8 @@ const (
 
 // LeadingZeros returns the number of leading zero bits in w;
 // it returns 64 when w is zero.
+//
+// Deprecated: In Go 1.9 this function is available in package math/bits as LeadingZeros64.
 func LeadingZeros(w uint64) int {
 	// Fill word with ones on the right, e.g. 0x0000f308 -> 0x0000ffff.
 	w |= w >> 1
@@ -27,6 +29,8 @@ func LeadingZeros(w uint64) int {
 
 // TrailingZeros returns the number of trailing zero bits in w;
 // it returns 64 when w is zero.
+//
+// Deprecated: In Go 1.9 this function is available in package math/bits as TrailingZeros64.
 func TrailingZeros(w uint64) int {
 	// “Using de Bruijn Sequences to Index a 1 in a Computer Word”,
 	// Leiserson, Prokop, and Randall, MIT, 1998.
@@ -53,6 +57,8 @@ func init() {
 }
 
 // Count returns the number of nonzero bits in w.
+//
+// Deprecated: In Go 1.9 this function is available in package math/bits as OnesCount64.
 func Count(w uint64) int {
 	// “Software Optimization Guide for AMD64 Processors”, Section 8.6.
 	const maxw = 1<<64 - 1

set.go

@@ -1,3 +1,5 @@
+// +build !go1.9
+
 // Package bit provides a bit array implementation
 // and some utility bit functions.
 //