Rename Or -> Union

Author: korthaj

example_test.go

@@ -7,7 +7,7 @@ import (
 	"strconv"
 )
 
-// Create and use a Bloom filter.
+// Build a blacklist of shady websites.
 func Example_basics() {
 	// Create a Bloom filter with room for 10000 elements
 	// at a false-positives rate less than 0.5 percent.
@@ -28,10 +28,9 @@ func Example_basics() {
 
 // Count the number of false positives.
 func Example_falsePositives() {
-	// Create a Bloom filter with room for 10000 elements
-	// at a false-positives rate less than 1/100.
-	n := 10000
-	p := 100
+	// Create a Bloom filter with room for n elements
+	// at a false-positives rate less than 1/p.
+	n, p := 10000, 100
 	filter := bloom.New(n, p)
 
 	// Add n random strings.
@@ -70,6 +69,6 @@ func ExampleFilter_Or() {
 	}
 
 	// Compute the approximate size of f1 ∪ f2.
-	fmt.Println("f1 ∪ f2:", f1.Or(f2).Count())
+	fmt.Println("f1 ∪ f2:", f1.Union(f2).Count())
 	// Output: f1 ∪ f2: 505
 }

filter.go

@@ -122,13 +122,13 @@ func (f *Filter) Count() int64 {
 	return f.count
 }
 
-// Or returns a new Bloom filter that consists of all elements
+// Union returns a new Bloom filter that consists of all elements
 // that belong to either f1 or f2. The two filters must be of
 // the same size n and have the same false-positives rate p.
 //
 // The resulting filter is the same as the filter created
 // from scratch using the union of the two sets.
-func (f1 *Filter) Or(f2 *Filter) *Filter {
+func (f1 *Filter) Union(f2 *Filter) *Filter {
 	if len(f1.data) != len(f2.data) || f1.lookups != f2.lookups {
 		panic("operation requires filters of the same type")
 	}

filter_test.go

@@ -58,7 +58,7 @@ func TestFilter(t *testing.T) {
 	}
 }
 
-func TestOr(t *testing.T) {
+func TestUnion(t *testing.T) {
 	s1 := "asöldkgjaösldkgaösldkasldgjkaösldkgjöasgkdjg"
 	s2 := "elasödlnkgaölsdkfgaölsdkjfaölsdkgaölskgnaösl"
 	s3 := "aölsdgkaösldkgaösldkgjaölsdkjgaölsdkgjaösldk"
@@ -69,7 +69,7 @@ func TestOr(t *testing.T) {
 			f1.Add(s2)
 			f2.Add(s2)
 			f2.Add(s3)
-			or := f1.Or(f2)
+			or := f1.Union(f2)
 			member := or.Test(s1)
 			if !member {
 				t.Errorf("or.Test(s1) = %v; want true\n", member)
@@ -126,13 +126,13 @@ func BenchmarkTestByte(b *testing.B) {
 	}
 }
 
-func BenchmarkTestOr(b *testing.B) {
+func BenchmarkTestUnion(b *testing.B) {
 	n := 1000
 	b.StopTimer()
 	f1 := New(n, 200)
 	f2 := New(n, 200)
 	b.StartTimer()
 	for i := 0; i < b.N; i++ {
-		_ = f1.Or(f2)
+		_ = f1.Union(f2)
 	}
 }