github.com/creachadair/ffs@v0.17.3/index/example_test.go (about)

     1  // Copyright 2021 Michael J. Fromberger. All Rights Reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package index_test
    16  
    17  import (
    18  	"fmt"
    19  	"strings"
    20  
    21  	"github.com/creachadair/ffs/index"
    22  )
    23  
    24  func ExampleIndex() {
    25  	words := strings.Fields("a foolish consistency is the hobgoblin of little minds")
    26  
    27  	idx := index.New(32, nil)
    28  	for _, word := range words {
    29  		idx.Add(word)
    30  	}
    31  
    32  	fmt.Printf("Has %q: %v\n", "foolish", idx.Has("foolish"))
    33  	fmt.Printf("Has %q: %v\n", "cabbage", idx.Has("cabbage"))
    34  
    35  	info := idx.Stats()
    36  	fmt.Printf("%d keys, %d filter bits, %d hash seeds\n",
    37  		info.NumKeys, info.FilterBits, info.NumHashes)
    38  
    39  	// Output:
    40  	// Has "foolish": true
    41  	// Has "cabbage": false
    42  	// 9 keys, 256 filter bits, 6 hash seeds
    43  }