BLI_math_rotation: properly name the quaternion power function.
[blender.git] / source / blender / blenlib / intern / hash_mm3.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * ***** END GPL LICENSE BLOCK *****
19  *
20  * Copyright (C) 2018 Blender Foundation.
21  *
22  */
23
24 /** \file blender/blenlib/intern/hash_mm3.c
25  *  \ingroup bli
26  *
27  *  Functions to compute Murmur3 hash key.
28  *
29  * This Code is based on alShaders/Cryptomatte/MurmurHash3.h:
30  *
31  * MurmurHash3 was written by Austin Appleby, and is placed in the public
32  * domain. The author hereby disclaims copyright to this source code.
33  *
34  */
35
36 #include "BLI_compiler_compat.h"
37 #include "BLI_compiler_attrs.h"
38 #include "BLI_hash_mm3.h"  /* own include */
39
40 #if defined(_MSC_VER)
41 #  include <stdlib.h>
42 #  define ROTL32(x,y) _rotl(x,y)
43 #  define BIG_CONSTANT(x) (x)
44
45 /* Other compilers */
46 #else   /* defined(_MSC_VER) */
47 static inline uint32_t rotl32(uint32_t x, int8_t r)
48 {
49         return (x << r) | (x >> (32 - r));
50 }
51 #  define ROTL32(x,y) rotl32(x,y)
52 #  define BIG_CONSTANT(x) (x##LLU)
53 #endif /* !defined(_MSC_VER) */
54
55 /* Block read - if your platform needs to do endian-swapping or can only
56  * handle aligned reads, do the conversion here
57  */
58
59 BLI_INLINE uint32_t getblock32(const uint32_t * p, int i)
60 {
61         return p[i];
62 }
63
64 BLI_INLINE uint64_t getblock64(const uint64_t * p, int i)
65 {
66         return p[i];
67 }
68
69 /* Finalization mix - force all bits of a hash block to avalanche */
70
71 BLI_INLINE uint32_t fmix32(uint32_t h)
72 {
73         h ^= h >> 16;
74         h *= 0x85ebca6b;
75         h ^= h >> 13;
76         h *= 0xc2b2ae35;
77         h ^= h >> 16;
78
79         return h;
80 }
81
82 BLI_INLINE uint64_t fmix64(uint64_t k)
83 {
84         k ^= k >> 33;
85         k *= BIG_CONSTANT(0xff51afd7ed558ccd);
86         k ^= k >> 33;
87         k *= BIG_CONSTANT(0xc4ceb9fe1a85ec53);
88         k ^= k >> 33;
89
90         return k;
91 }
92
93 uint32_t BLI_hash_mm3(const unsigned char *in, size_t len, uint32_t seed)
94 {
95         const uint8_t *data = (const uint8_t *)in;
96         const int nblocks = len / 4;
97
98         uint32_t h1 = seed;
99
100         const uint32_t c1 = 0xcc9e2d51;
101         const uint32_t c2 = 0x1b873593;
102
103         /* body */
104
105         const uint32_t *blocks = (const uint32_t *)(data + nblocks * 4);
106
107         for (int i = -nblocks; i; i++) {
108                 uint32_t k1 = getblock32(blocks, i);
109
110                 k1 *= c1;
111                 k1 = ROTL32(k1, 15);
112                 k1 *= c2;
113
114                 h1 ^= k1;
115                 h1 = ROTL32(h1, 13);
116                 h1 = h1 * 5 + 0xe6546b64;
117         }
118
119         /* tail */
120
121         const uint8_t *tail = (const uint8_t *)(data + nblocks * 4);
122
123         uint32_t k1 = 0;
124
125         switch (len & 3) {
126                 case 3:
127                         k1 ^= tail[2] << 16;
128                         ATTR_FALLTHROUGH;
129                 case 2:
130                         k1 ^= tail[1] << 8;
131                         ATTR_FALLTHROUGH;
132                 case 1:
133                         k1 ^= tail[0];
134                         k1 *= c1;
135                         k1 = ROTL32(k1, 15);
136                         k1 *= c2;
137                         h1 ^= k1;
138         }
139
140         /* finalization */
141
142         h1 ^= len;
143
144         h1 = fmix32(h1);
145
146         return h1;
147 }