├── go.mod
├── .gitignore
├── CONTRIBUTING.md
├── examples_test.go
├── runemap_test.go
├── bytemap_test.go
├── README.md
├── runemap.go
├── bytemap.go
├── doc.go
├── benchmark_test.go
└── LICENSE


/go.mod:
--------------------------------------------------------------------------------
1 | module github.com/google/triemap
2 | 
3 | go 1.14
4 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Binaries for programs and plugins
 2 | *.exe
 3 | *.exe~
 4 | *.dll
 5 | *.so
 6 | *.dylib
 7 | 
 8 | # Test binary, built with `go test -c`
 9 | *.test
10 | 
11 | # Output of the go coverage tool, specifically when used with LiteIDE
12 | *.out
13 | 
14 | # Random files created by OS or IDE
15 | .DS_Store
16 | .idea/
17 | 
18 | # Dependency directories (remove the comment below to include it)
19 | # vendor/
20 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # How to Contribute
 2 | 
 3 | We'd love to accept your patches and contributions to this project. There are
 4 | just a few small guidelines you need to follow.
 5 | 
 6 | ## Contributor License Agreement
 7 | 
 8 | Contributions to this project must be accompanied by a Contributor License
 9 | Agreement (CLA). You (or your employer) retain the copyright to your
10 | contribution; this simply gives us permission to use and redistribute your
11 | contributions as part of the project. Head over to
12 | <https://cla.developers.google.com/> to see your current agreements on file or
13 | to sign a new one.
14 | 
15 | You generally only need to submit a CLA once, so if you've already submitted one
16 | (even if it was for a different project), you probably don't need to do it
17 | again.
18 | 
19 | ## Code reviews
20 | 
21 | All submissions, including submissions by project members, require review. We
22 | use GitHub pull requests for this purpose. Consult
23 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
24 | information on using pull requests.
25 | 
26 | ## Community Guidelines
27 | 
28 | This project follows
29 | [Google's Open Source Community Guidelines](https://opensource.google/conduct/).
30 | 
31 | 


--------------------------------------------------------------------------------
/examples_test.go:
--------------------------------------------------------------------------------
 1 | // Copyright 2020 Google LLC
 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 triemap_test
16 | 
17 | import (
18 | 	"fmt"
19 | 
20 | 	"github.com/google/triemap"
21 | )
22 | 
23 | func ExampleRuneSliceMap() {
24 | 	var m triemap.RuneSliceMap
25 | 
26 | 	m.PutString("foo", 123)
27 | 	m.Put([]rune{'b', 'a', 'r'}, 456)
28 | 
29 | 	v, ok := m.Get([]rune{'f', 'o', 'o'})
30 | 	fmt.Println("Get([]rune{'f', 'o', 'o'}):", v, ok)
31 | 
32 | 	v, ok = m.GetString("bar")
33 | 	fmt.Println("GetString('bar'):", v, ok)
34 | 
35 | 	v, ok = m.GetString("baz")
36 | 	fmt.Println("GetString('baz'):", v, ok)
37 | 	// Output: Get([]rune{'f', 'o', 'o'}): 123 true
38 | 	// GetString('bar'): 456 true
39 | 	// GetString('baz'): <nil> false
40 | }
41 | 


--------------------------------------------------------------------------------
/runemap_test.go:
--------------------------------------------------------------------------------
 1 | // Copyright 2020 Google LLC
 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 triemap
16 | 
17 | import (
18 | 	"testing"
19 | )
20 | 
21 | func TestRuneMap(t *testing.T) {
22 | 	var m RuneSliceMap
23 | 	m.Put([]rune{'f', 'ಠ', 'o'}, 123)
24 | 	m.PutString("foo", 456)
25 | 
26 | 	v1, ok1 := m.GetString("fಠo")
27 | 	if !ok1 {
28 | 		t.Error("GetString('fಠo') ok=false, want: true")
29 | 	}
30 | 	if got, want := v1.(int), 123; got != want {
31 | 		t.Errorf("GetString('fಠo')=%v, want: %v", got, want)
32 | 	}
33 | 
34 | 	v2, ok2 := m.Get([]rune{'f', 'o', 'o'})
35 | 	if !ok2 {
36 | 		t.Error("Get('foo') ok=false, want: true")
37 | 	}
38 | 	if got, want := v2.(int), 456; got != want {
39 | 		t.Errorf("Get('foo')=%v, want: %v", got, want)
40 | 	}
41 | }
42 | 
43 | func TestRuneMapMissingValue(t *testing.T) {
44 | 	var m RuneSliceMap
45 | 	m.PutString("foo", nil)
46 | 
47 | 	v1, ok1 := m.GetString("fಠo")
48 | 	if ok1 {
49 | 		t.Error("GetString('fಠo') ok=true, want: false")
50 | 	}
51 | 	if v1 != nil {
52 | 		t.Errorf("GetString('fಠo')=%v, want want nil", v1)
53 | 	}
54 | 
55 | 	v2, ok2 := m.Get([]rune{'f', 'o', 'o'})
56 | 	if !ok2 {
57 | 		t.Error("Get('foo') ok=false, want: true")
58 | 	}
59 | 	if v2 != nil {
60 | 		t.Errorf("Get('foo')=%v, want: nil", v2)
61 | 	}
62 | }
63 | 


--------------------------------------------------------------------------------
/bytemap_test.go:
--------------------------------------------------------------------------------
 1 | // Copyright 2020 Google LLC
 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 triemap
16 | 
17 | import (
18 | 	"testing"
19 | )
20 | 
21 | func TestByteMap(t *testing.T) {
22 | 	var m ByteSliceMap
23 | 	ಠ := []byte("fಠo")
24 | 
25 | 	m.Put(ಠ, 123)
26 | 	m.PutString("foo", 456)
27 | 
28 | 	v1, ok1 := m.GetString("fಠo")
29 | 	if !ok1 {
30 | 		t.Error("GetString('fಠo') ok=false, want: true")
31 | 	}
32 | 	if got, want := v1.(int), 123; got != want {
33 | 		t.Errorf("GetString('fಠo')=%v, want: %v", got, want)
34 | 	}
35 | 
36 | 	v2, ok2 := m.Get([]byte{'f', 'o', 'o'})
37 | 	if !ok2 {
38 | 		t.Error("Get('foo') ok=false, want: true")
39 | 	}
40 | 	if got, want := v2.(int), 456; got != want {
41 | 		t.Errorf("Get('foo')=%v, want: %v", got, want)
42 | 	}
43 | }
44 | 
45 | func TestByteMapMissingValue(t *testing.T) {
46 | 	var m ByteSliceMap
47 | 	m.PutString("foo", nil)
48 | 
49 | 	v1, ok1 := m.GetString("fಠo")
50 | 	if ok1 {
51 | 		t.Error("GetString('fಠo') ok=true, want: false")
52 | 	}
53 | 	if v1 != nil {
54 | 		t.Errorf("GetString('fಠo')=%v, want want nil", v1)
55 | 	}
56 | 
57 | 	v2, ok2 := m.Get([]byte{'f', 'o', 'o'})
58 | 	if !ok2 {
59 | 		t.Error("Get('foo') ok=false, want: true")
60 | 	}
61 | 	if v2 != nil {
62 | 		t.Errorf("Get('foo')=%v, want: nil", v2)
63 | 	}
64 | }
65 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # triemap
 2 | Map using `[]rune` or `[]byte` instead of `string`
 3 | 
 4 | > Disclaimer: This is not an official Google product.
 5 | 
 6 | * `RuneSliceMap` is much faster than casting and using a map like: `map[string(slice)]`.
 7 | * `ByteSliceMap` is considerably slower than standard maps, but it reduces allocations.
 8 | 
 9 | ## Usage
10 | 
11 | ```go
12 | var m triemap.RuneSliceMap
13 | 
14 | m.PutString("foo", 123)
15 | m.Put([]rune{'b', 'a', 'r'}, 456)
16 | 
17 | v, ok := m.Get([]rune{'f', 'o', 'o'})
18 | fmt.Println(v, ok) // 123, true
19 | 
20 | v, ok = m.GetString("bar")
21 | fmt.Println(v, ok) // 456, true
22 | 
23 | v, ok = m.GetString("baz")
24 | fmt.Println(v, ok) // nil, baz
25 | ```
26 | 
27 | ## Benchmarks
28 | 
29 | ```
30 | name                     time/op
31 | GetByteMap20/ByteMap-16  1.82µs ± 0%
32 | GetByteMap20/StdMap-16    883ns ±14%
33 | GetRuneMap20/RuneMap-16   639ns ± 0%
34 | GetRuneMap20/StdMap-16   1.45µs ± 5%
35 | PutByteMap20/ByteMap-16  2.13µs ± 2%
36 | PutByteMap20/StdMap-16    579ns ± 6%
37 | PutRuneMap20/RuneMap-16  1.09µs ± 5%
38 | PutRuneMap20/StdMap-16   1.26µs ± 4%
39 | 
40 | name                     alloc/op
41 | GetByteMap20/ByteMap-16   0.00B
42 | GetByteMap20/StdMap-16     320B ± 0%
43 | GetRuneMap20/RuneMap-16   0.00B
44 | GetRuneMap20/StdMap-16     320B ± 0%
45 | PutByteMap20/ByteMap-16    320B ± 0%
46 | PutByteMap20/StdMap-16     128B ± 0%
47 | PutRuneMap20/RuneMap-16    320B ± 0%
48 | PutRuneMap20/StdMap-16     208B ± 0%
49 | 
50 | name                     allocs/op
51 | GetByteMap20/ByteMap-16    0.00
52 | GetByteMap20/StdMap-16     20.0 ± 0%
53 | GetRuneMap20/RuneMap-16    0.00
54 | GetRuneMap20/StdMap-16     20.0 ± 0%
55 | PutByteMap20/ByteMap-16    20.0 ± 0%
56 | PutByteMap20/StdMap-16     19.0 ± 0%
57 | PutRuneMap20/RuneMap-16    20.0 ± 0%
58 | PutRuneMap20/StdMap-16     20.0 ± 0%
59 | ```
60 | 
61 | ## Code of Conduct
62 | 
63 | [Same as Go](https://golang.org/conduct)
64 | 
65 | ## Contributing
66 | 
67 | Read our [contributions](CONTRIBUTING.md) doc.
68 | 
69 | tl;dr: Get Google's CLA and send a PR!
70 | 
71 | ## Licence
72 | 
73 | [Apache 2.0](LICENSE)
74 | 


--------------------------------------------------------------------------------
/runemap.go:
--------------------------------------------------------------------------------
 1 | // Copyright 2020 Google LLC
 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 triemap
16 | 
17 | // RuneSliceMap emulates `map[[]rune]interface{}`, implemented as a Trie.
18 | type RuneSliceMap struct {
19 | 	value    interface{}
20 | 	children map[rune]*RuneSliceMap
21 | }
22 | 
23 | // PutString is a convenience method to insert a value using a string key.
24 | func (n *RuneSliceMap) PutString(s string, v interface{}) *RuneSliceMap {
25 | 	return n.Put([]rune(s), v)
26 | }
27 | 
28 | // Put inserts a value into the `RuneMap` using `[]rune` as a key
29 | func (n *RuneSliceMap) Put(s []rune, v interface{}) *RuneSliceMap {
30 | 	for _, r := range s {
31 | 		n = n.put(r)
32 | 	}
33 | 	n.value = v
34 | 	return n
35 | }
36 | 
37 | func (n *RuneSliceMap) put(r rune) *RuneSliceMap {
38 | 	if child, ok := n.children[r]; ok {
39 | 		return child
40 | 	}
41 | 	var child RuneSliceMap
42 | 	if n.children == nil {
43 | 		n.children = map[rune]*RuneSliceMap{r: &child}
44 | 	} else {
45 | 		n.children[r] = &child
46 | 	}
47 | 	return &child
48 | }
49 | 
50 | // Get returns a value as mapped by the `[]rune` key and a boolean of whether the value exists in the map.
51 | func (n *RuneSliceMap) Get(s []rune) (interface{}, bool) {
52 | 	for _, r := range s {
53 | 		var ok bool
54 | 		if n, ok = n.children[r]; !ok {
55 | 			return nil, false
56 | 		}
57 | 	}
58 | 	return n.value, true
59 | }
60 | 
61 | // GetString is a convenience method to get a value using a string key.
62 | //
63 | // See: `Get`
64 | func (n *RuneSliceMap) GetString(s string) (interface{}, bool) {
65 | 	return n.Get([]rune(s))
66 | }
67 | 


--------------------------------------------------------------------------------
/bytemap.go:
--------------------------------------------------------------------------------
 1 | // Copyright 2020 Google LLC
 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 triemap
16 | 
17 | // ByteSliceMap emulates `map[[]byte]interface{}`, implemented as a Trie.
18 | //
19 | // It seems to perform worse than `map[string]interface{}` even when casting `string([]byte)`
20 | type ByteSliceMap struct {
21 | 	value    interface{}
22 | 	children map[byte]*ByteSliceMap
23 | }
24 | 
25 | // PutString is a convenience method to insert a value using a string key.
26 | func (n *ByteSliceMap) PutString(s string, v interface{}) *ByteSliceMap {
27 | 	return n.Put([]byte(s), v)
28 | }
29 | 
30 | // Put inserts a value into the `ByteMap` using `[]byte` as a key
31 | func (n *ByteSliceMap) Put(s []byte, v interface{}) *ByteSliceMap {
32 | 	for _, r := range s {
33 | 		n = n.put(r)
34 | 	}
35 | 	n.value = v
36 | 	return n
37 | }
38 | 
39 | func (n *ByteSliceMap) put(r byte) *ByteSliceMap {
40 | 	if child, ok := n.children[r]; ok {
41 | 		return child
42 | 	}
43 | 	var child ByteSliceMap
44 | 	if n.children == nil {
45 | 		n.children = map[byte]*ByteSliceMap{r: &child}
46 | 	} else {
47 | 		n.children[r] = &child
48 | 	}
49 | 	return &child
50 | }
51 | 
52 | // Get returns a value as mapped by the `[]byte` key and a boolean of whether the value exists in the map.
53 | func (n *ByteSliceMap) Get(s []byte) (interface{}, bool) {
54 | 	for _, r := range s {
55 | 		var ok bool
56 | 		if n, ok = n.children[r]; !ok {
57 | 			return nil, false
58 | 		}
59 | 	}
60 | 	return n.value, true
61 | }
62 | 
63 | // GetString is a convenience method to get a value using a string key.
64 | //
65 | // See: `Get`
66 | func (n *ByteSliceMap) GetString(s string) (interface{}, bool) {
67 | 	return n.Get([]byte(s))
68 | }
69 | 


--------------------------------------------------------------------------------
/doc.go:
--------------------------------------------------------------------------------
 1 | // Copyright 2020 Google LLC
 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 triemap allows creating a map out of `[]rune` and `[]byte` without casting with
16 | // `string(v)`.
17 | //
18 | // Due to lack of generics the values are stored and retrieved as `interface{}` and require type
19 | // asserting like `m.Get(k).(Foo)`.
20 | //
21 | // Compared to casting a rune or byte slice to a string, putting data in the map is actually better
22 | // using the std map like `m[string(k)] = v`, however getting data out of the map is much faster
23 | // with the `RuneSliceMap`.
24 | //
25 | //     name                     time/op
26 | //     GetByteMap20/ByteMap-16  1.82µs ± 0%
27 | //     GetByteMap20/StdMap-16    883ns ±14%
28 | //     GetRuneMap20/RuneMap-16   639ns ± 0%
29 | //     GetRuneMap20/StdMap-16   1.45µs ± 5%
30 | //     PutByteMap20/ByteMap-16  2.13µs ± 2%
31 | //     PutByteMap20/StdMap-16    579ns ± 6%
32 | //     PutRuneMap20/RuneMap-16  1.09µs ± 5%
33 | //     PutRuneMap20/StdMap-16   1.26µs ± 4%
34 | //
35 | //     name                     alloc/op
36 | //     GetByteMap20/ByteMap-16   0.00B
37 | //     GetByteMap20/StdMap-16     320B ± 0%
38 | //     GetRuneMap20/RuneMap-16   0.00B
39 | //     GetRuneMap20/StdMap-16     320B ± 0%
40 | //     PutByteMap20/ByteMap-16    320B ± 0%
41 | //     PutByteMap20/StdMap-16     128B ± 0%
42 | //     PutRuneMap20/RuneMap-16    320B ± 0%
43 | //     PutRuneMap20/StdMap-16     208B ± 0%
44 | //
45 | //     name                     allocs/op
46 | //     GetByteMap20/ByteMap-16    0.00
47 | //     GetByteMap20/StdMap-16     20.0 ± 0%
48 | //     GetRuneMap20/RuneMap-16    0.00
49 | //     GetRuneMap20/StdMap-16     20.0 ± 0%
50 | //     PutByteMap20/ByteMap-16    20.0 ± 0%
51 | //     PutByteMap20/StdMap-16     19.0 ± 0%
52 | //     PutRuneMap20/RuneMap-16    20.0 ± 0%
53 | //     PutRuneMap20/StdMap-16     20.0 ± 0%
54 | //
55 | // `ByteSliceMap` is always slower than casting to string and using a standard map, but it
56 | // reduces allocations, so it's a decent alternative on memory-constrained resources.
57 | //
58 | // `RuneSliceMap` performs much faster and produces less allocations than casting to string and
59 | // using standard maps.
60 | package triemap
61 | 


--------------------------------------------------------------------------------
/benchmark_test.go:
--------------------------------------------------------------------------------
  1 | // Copyright 2020 Google LLC
  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 triemap
 16 | 
 17 | import "testing"
 18 | 
 19 | var (
 20 | 	keys = []string{
 21 | 		"Lorem",
 22 | 		"ipsum",
 23 | 		"dolor",
 24 | 		"sit",
 25 | 		"amet",
 26 | 		"consectetur",
 27 | 		"adipiscing",
 28 | 		"elit",
 29 | 		"Donec",
 30 | 		"euismod",
 31 | 		"leo",
 32 | 		"id",
 33 | 		"laoreet",
 34 | 		"feugiat",
 35 | 		"augue",
 36 | 		"magna",
 37 | 		"tincidunt",
 38 | 		"dolor",
 39 | 		"a",
 40 | 		"rhoncus",
 41 | 	}
 42 | 
 43 | 	values = []string{
 44 | 		"rhoncus",
 45 | 		"a",
 46 | 		"dolor",
 47 | 		"tincidunt",
 48 | 		"magna",
 49 | 		"augue",
 50 | 		"feugiat",
 51 | 		"laoreet",
 52 | 		"id",
 53 | 		"leo",
 54 | 		"euismod",
 55 | 		"Donec",
 56 | 		"elit",
 57 | 		"adipiscing",
 58 | 		"consectetur",
 59 | 		"amet",
 60 | 		"sit",
 61 | 		"dolor",
 62 | 		"ipsum",
 63 | 		"Lorem",
 64 | 	}
 65 | )
 66 | 
 67 | func BenchmarkPutRuneMap20(b *testing.B) {
 68 | 	var runeKeys [][]rune
 69 | 	for _, v := range keys {
 70 | 		runeKeys = append(runeKeys, []rune(v))
 71 | 	}
 72 | 
 73 | 	runeMaps := make([]RuneSliceMap, 20)
 74 | 	stdMaps := make([]map[string]string, 20)
 75 | 	for i := range stdMaps {
 76 | 		stdMaps[i] = make(map[string]string)
 77 | 	}
 78 | 
 79 | 	testCases := []struct {
 80 | 		desc string
 81 | 		put  func(int, []rune, string)
 82 | 	}{
 83 | 		{
 84 | 			"RuneMap",
 85 | 			func(i int, key []rune, v string) { runeMaps[i].Put(key, v) },
 86 | 		},
 87 | 		{
 88 | 			"StdMap",
 89 | 			func(i int, key []rune, v string) { stdMaps[i][string(key)] = v },
 90 | 		},
 91 | 	}
 92 | 
 93 | 	b.ResetTimer()
 94 | 	for _, tc := range testCases {
 95 | 		b.Run(tc.desc, func(b *testing.B) {
 96 | 			for i := 0; i < b.N; i++ {
 97 | 				for j := 0; j < 20; j++ {
 98 | 					tc.put(j, runeKeys[j], values[j])
 99 | 				}
100 | 			}
101 | 		})
102 | 	}
103 | }
104 | 
105 | func BenchmarkGetRuneMap20(b *testing.B) {
106 | 	var runeKeys [][]rune
107 | 	for _, v := range keys {
108 | 		runeKeys = append(runeKeys, []rune(v))
109 | 	}
110 | 
111 | 	var r RuneSliceMap
112 | 	m := make(map[string]string)
113 | 	for j := 0; j < 20; j++ {
114 | 		r.Put(runeKeys[j], values[j])
115 | 		m[keys[j]] = values[j]
116 | 	}
117 | 
118 | 	testCases := []struct {
119 | 		desc string
120 | 		get  func([]rune) (interface{}, bool)
121 | 	}{
122 | 		{"RuneMap", func(key []rune) (interface{}, bool) { return r.Get(key) }},
123 | 		{"StdMap", func(key []rune) (interface{}, bool) {
124 | 			v, ok := m[string(key)]
125 | 			return v, ok
126 | 		}},
127 | 	}
128 | 
129 | 	b.ResetTimer()
130 | 	for _, tc := range testCases {
131 | 		b.Run(tc.desc, func(b *testing.B) {
132 | 			for i := 0; i < b.N; i++ {
133 | 				for j := 0; j < 20; j++ {
134 | 					_, _ = tc.get(runeKeys[j])
135 | 				}
136 | 			}
137 | 		})
138 | 	}
139 | }
140 | 
141 | func BenchmarkPutByteMap20(b *testing.B) {
142 | 	var byteKeys [][]byte
143 | 	for _, v := range keys {
144 | 		byteKeys = append(byteKeys, []byte(v))
145 | 	}
146 | 
147 | 	byteMaps := make([]ByteSliceMap, 20)
148 | 	stdMaps := make([]map[string]string, 20)
149 | 	for i := range stdMaps {
150 | 		stdMaps[i] = make(map[string]string)
151 | 	}
152 | 
153 | 	testCases := []struct {
154 | 		desc string
155 | 		put  func(int, []byte, string)
156 | 	}{
157 | 		{
158 | 			"ByteMap",
159 | 			func(i int, key []byte, v string) { byteMaps[i].Put(key, v) },
160 | 		},
161 | 		{
162 | 			"StdMap",
163 | 			func(i int, key []byte, v string) { stdMaps[i][string(key)] = v },
164 | 		},
165 | 	}
166 | 
167 | 	b.ResetTimer()
168 | 	for _, tc := range testCases {
169 | 		b.Run(tc.desc, func(b *testing.B) {
170 | 			for i := 0; i < b.N; i++ {
171 | 				for j := 0; j < 20; j++ {
172 | 					tc.put(j, byteKeys[j], values[j])
173 | 				}
174 | 			}
175 | 		})
176 | 	}
177 | }
178 | 
179 | func BenchmarkGetByteMap20(b *testing.B) {
180 | 	var byteKeys [][]byte
181 | 	for _, v := range keys {
182 | 		byteKeys = append(byteKeys, []byte(v))
183 | 	}
184 | 
185 | 	var r ByteSliceMap
186 | 	m := make(map[string]string)
187 | 	for j := 0; j < 20; j++ {
188 | 		r.Put(byteKeys[j], values[j])
189 | 		m[keys[j]] = values[j]
190 | 	}
191 | 
192 | 	testCases := []struct {
193 | 		desc string
194 | 		get  func([]byte) (interface{}, bool)
195 | 	}{
196 | 		{"ByteMap", func(key []byte) (interface{}, bool) { return r.Get(key) }},
197 | 		{"StdMap", func(key []byte) (interface{}, bool) {
198 | 			v, ok := m[string(key)]
199 | 			return v, ok
200 | 		}},
201 | 	}
202 | 
203 | 	b.ResetTimer()
204 | 	for _, tc := range testCases {
205 | 		b.Run(tc.desc, func(b *testing.B) {
206 | 			for i := 0; i < b.N; i++ {
207 | 				for j := 0; j < 20; j++ {
208 | 					_, _ = tc.get(byteKeys[j])
209 | 				}
210 | 			}
211 | 		})
212 | 	}
213 | }
214 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [yyyy] [name of copyright owner]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------