├── .github └── workflows │ └── go.yml ├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── circle.yml ├── go.mod ├── go.sum ├── murmur.go └── murmur_test.go /.github/workflows/go.yml: -------------------------------------------------------------------------------- 1 | name: Go 2 | on: [push] 3 | jobs: 4 | build: 5 | name: Build 6 | runs-on: ubuntu-latest 7 | 8 | steps: 9 | - name: Set up Go 1.17 10 | uses: actions/setup-go@v1 11 | with: 12 | go-version: 1.17 13 | id: go 14 | 15 | - name: Check out code into the Go module directory 16 | uses: actions/checkout@v1 17 | 18 | - name: Get dependencies 19 | run: | 20 | go get -v -t -d ./... 21 | # if [ -f Gopkg.toml ]; then 22 | # curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh 23 | # dep ensure 24 | # fi 25 | 26 | - name: Build 27 | run: go build -v . 28 | - name: Test 29 | run: go test -v . 30 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Object files 2 | .DS_Store 3 | .vscode 4 | .idea 5 | 6 | examples/examples 7 | vendor/github.com/vcaesar/tt 8 | 9 | # Debug files 10 | *.dSYM/ 11 | *.su 12 | debug 13 | 14 | # Architecture specific extensions/prefixes 15 | *.[568vq] 16 | [568vq].out 17 | 18 | *.cgo1.go 19 | *.cgo2.c 20 | _cgo_defun.c 21 | _cgo_gotypes.go 22 | _cgo_export.* 23 | 24 | _testmain.go 25 | 26 | *.o 27 | *.ko 28 | *.obj 29 | *.elf 30 | 31 | # Precompiled Headers 32 | *.gch 33 | *.pch 34 | 35 | # Libraries 36 | *.lib 37 | *.a 38 | *.la 39 | *.lo 40 | 41 | # Shared objects (inc. Windows DLLs) 42 | *.dll 43 | *.so 44 | *.so.* 45 | *.dylib 46 | 47 | # Executables 48 | *.exe 49 | *.out 50 | *.app 51 | *.i*86 52 | *.x86_64 53 | *.hex 54 | 55 | # Binaries for programs and plugins 56 | 57 | # Test binary, build with `go test -c` 58 | *.test 59 | 60 | # Output of the go coverage tool, specifically when used with LiteIDE 61 | # *.out 62 | 63 | # Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736 64 | .glide/ 65 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: go 2 | 3 | go_import_path: github.com/go-ego/murmur 4 | 5 | go: 6 | # - 1.7.x 7 | # - 1.8.x 8 | # - 1.9.x 9 | # - 1.10.x 10 | # - 1.11.x 11 | # - 1.12.x 12 | # - 1.13.x 13 | # - 1.14.x 14 | # - 1.15.x 15 | - 1.17.x 16 | # - tip 17 | 18 | install: 19 | - export PATH=$PATH:$HOME/gopath/bin 20 | - go get -v -t ./... 21 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # murmur 2 | 3 | [![Build Status](https://github.com/vcaesar/murmur/workflows/Go/badge.svg)](https://github.com/vcaesar/murmur/commits/master) 4 | [![CircleCI Status](https://circleci.com/gh/vcaesar/murmur.svg?style=shield)](https://circleci.com/gh/vcaesar/murmur) 5 | [![codecov](https://codecov.io/gh/vcaesar/murmur/branch/master/graph/badge.svg)](https://codecov.io/gh/vcaesar/murmur) 6 | [![Build Status](https://travis-ci.org/vcaesar/murmur.svg)](https://travis-ci.org/vcaesar/murmur) 7 | [![Go Report Card](https://goreportcard.com/badge/github.com/vcaesar/murmur)](https://goreportcard.com/report/github.com/vcaesar/murmur) 8 | [![GoDoc](https://godoc.org/github.com/vcaesar/murmur?status.svg)](https://godoc.org/github.com/vcaesar/murmur) 9 | [![Release](https://github-release-version.herokuapp.com/github/vcaesar/murmur/release.svg?style=flat)](https://github.com/vcaesar/murmur/releases/latest) 10 | [![Join the chat at https://gitter.im/vcaesar/ego](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vcaesar/ego?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 11 | 12 | Go Murmur3 hash implementation 13 | 14 | ## Installing 15 | ```Go 16 | go get -u github.com/vcaesar/murmur 17 | ``` 18 | 19 | ## Use 20 | 21 | ```Go 22 | package main 23 | 24 | import ( 25 | "log" 26 | 27 | "github.com/vcaesar/murmur" 28 | ) 29 | 30 | func main() { 31 | var str = "github.com/vcaesar/murmur" 32 | 33 | sum32 := murmur.Sum32(str) 34 | log.Println("hash32: ", sum32) 35 | 36 | sum32 = murmur.Sum32(str, 0) 37 | log.Println("hash32: ", hash32) 38 | 39 | hash32 := murmur.Murmur3([]byte(str)) 40 | log.Println("hash32...", hash32) 41 | 42 | hash32 = murmur.Murmur3([]byte(str), 1) 43 | log.Println("hash32...", hash32) 44 | } 45 | ``` 46 | 47 | Based on [MurmurHash](http://en.wikipedia.org/wiki/MurmurHash), thanks for murmur3. -------------------------------------------------------------------------------- /circle.yml: -------------------------------------------------------------------------------- 1 | # circle.yml # 2 | # machine: 3 | # go: 4 | # version: 1.9.1 5 | 6 | version: 2 7 | 8 | jobs: 9 | build: 10 | docker: 11 | - image: golang:1.17.1 12 | working_directory: /gopath/src/github.com/vcaesar/murmur 13 | steps: 14 | - checkout 15 | # specify any bash command here prefixed with `run: ` 16 | - run: go get -v -t -d ./... 17 | - run: go test -v ./... 18 | # codecov.io 19 | - run: go test -v -covermode=count -coverprofile=coverage.out 20 | - run: bash <(curl -s https://codecov.io/bash) 21 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/vcaesar/murmur 2 | 3 | go 1.17 4 | 5 | require github.com/vcaesar/tt v0.20.0 6 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/vcaesar/tt v0.20.0 h1:9t2Ycb9RNHcP0WgQgIaRKJBB+FrRdejuaL6uWIHuoBA= 2 | github.com/vcaesar/tt v0.20.0/go.mod h1:GHPxQYhn+7OgKakRusH7KJ0M5MhywoeLb8Fcffs/Gtg= 3 | -------------------------------------------------------------------------------- /murmur.go: -------------------------------------------------------------------------------- 1 | // Copyright 2016 ego authors 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"): you may 4 | // not use this file except in compliance with the License. You may obtain 5 | // 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, WITHOUT 11 | // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12 | // License for the specific language governing permissions and limitations 13 | // under the License. 14 | 15 | /* Package murmur Murmur3 hash function based on 16 | http://en.wikipedia.org/wiki/MurmurHash 17 | */ 18 | 19 | package murmur 20 | 21 | import ( 22 | "reflect" 23 | "unsafe" 24 | ) 25 | 26 | const ( 27 | c1 = 0xcc9e2d51 28 | c2 = 0x1b873593 29 | c3 = 0x85ebca6b 30 | c4 = 0xc2b2ae35 31 | nh = 0xe6546b64 32 | ) 33 | 34 | var ( 35 | // defaultSeed default murmur seed 36 | defaultSeed = uint32(1) 37 | ) 38 | 39 | // Murmur3 returns a hash from the provided key using the specified seed. 40 | func Murmur3(key []byte, seed ...uint32) uint32 { 41 | return Sum32(*(*string)((unsafe.Pointer)( 42 | &reflect.StringHeader{ 43 | Len: len(key), 44 | Data: (*reflect.SliceHeader)(unsafe.Pointer(&key)).Data, 45 | })), 46 | seed...) 47 | 48 | // return Sum32(string(key), seed...) 49 | } 50 | 51 | // Sum32 returns a hash from the provided key using the seed. 52 | func Sum32(key string, seed ...uint32) (hash uint32) { 53 | hash = defaultSeed 54 | if len(seed) > 0 { 55 | hash = seed[0] 56 | } 57 | 58 | var nbytes = len(key) / 4 * 4 59 | for i := 0; i < nbytes; i += 4 { 60 | k := uint32(key[i]) | uint32(key[i+1])<<8 | 61 | uint32(key[i+2])<<16 | uint32(key[i+3])<<24 62 | 63 | k *= c1 64 | k = (k << 15) | (k >> 17) 65 | k *= c2 66 | hash ^= k 67 | 68 | hash = (hash << 13) | (hash >> 19) 69 | hash = hash*5 + nh 70 | } 71 | 72 | var remaining uint32 73 | switch len(key) & 3 { 74 | case 3: 75 | remaining += uint32(key[nbytes+2]) << 16 76 | fallthrough 77 | case 2: 78 | remaining += uint32(key[nbytes+1]) << 8 79 | fallthrough 80 | case 1: 81 | remaining += uint32(key[nbytes]) 82 | remaining *= c1 83 | 84 | remaining = (remaining << 15) | (remaining >> 17) 85 | remaining = remaining * c2 86 | hash ^= remaining 87 | } 88 | 89 | hash ^= uint32(len(key)) 90 | hash ^= hash >> 16 91 | hash *= c3 92 | hash ^= hash >> 13 93 | hash *= c4 94 | hash ^= hash >> 16 95 | 96 | return 97 | } 98 | 99 | // func Sum64() { 100 | // } 101 | 102 | // func Sum128() { 103 | // } 104 | -------------------------------------------------------------------------------- /murmur_test.go: -------------------------------------------------------------------------------- 1 | package murmur 2 | 3 | import ( 4 | "testing" 5 | 6 | "github.com/vcaesar/tt" 7 | ) 8 | 9 | var ( 10 | testText = "The quick brown fox jumps over the lazy dog" 11 | text2 = "The fox jumps cog" 12 | ) 13 | 14 | func Benchmark_Sum32(b *testing.B) { 15 | fn := func() { 16 | Sum32(testText) 17 | } 18 | 19 | tt.BM(b, fn) 20 | 21 | } 22 | 23 | func Benchmark_Murmur3(b *testing.B) { 24 | fn := func() { 25 | Murmur3([]byte(testText)) 26 | } 27 | 28 | tt.BM(b, fn) 29 | } 30 | 31 | func TestMurmur3(t *testing.T) { 32 | tt.Equal(t, uint32(0x78e69e27), Murmur3([]byte(testText))) 33 | tt.Equal(t, 3709117227, Murmur3([]byte(text2), 1)) 34 | } 35 | 36 | func TestSum32(t *testing.T) { 37 | tt.Equal(t, uint32(0x78e69e27), Sum32(testText)) 38 | tt.Equal(t, 3709117227, Sum32(text2, 1)) 39 | } 40 | --------------------------------------------------------------------------------