Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / BLI_hash.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BLI_HASH_H__
18 #define __BLI_HASH_H__
19
20 /** \file \ingroup bli
21  */
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 BLI_INLINE unsigned int BLI_hash_int_2d(unsigned int kx, unsigned int ky)
28 {
29 #define rot(x, k) (((x) << (k)) | ((x) >> (32 - (k))))
30
31         unsigned int a, b, c;
32
33         a = b = c = 0xdeadbeef + (2 << 2) + 13;
34         a += kx;
35         b += ky;
36
37         c ^= b; c -= rot(b, 14);
38         a ^= c; a -= rot(c, 11);
39         b ^= a; b -= rot(a, 25);
40         c ^= b; c -= rot(b, 16);
41         a ^= c; a -= rot(c, 4);
42         b ^= a; b -= rot(a, 14);
43         c ^= b; c -= rot(b, 24);
44
45         return c;
46
47 #undef rot
48 }
49
50 BLI_INLINE unsigned int BLI_hash_string(const char *str)
51 {
52         unsigned int i = 0, c;
53
54         while ((c = *str++)) {
55                 i = i * 37 + c;
56         }
57         return i;
58 }
59
60 BLI_INLINE unsigned int BLI_hash_int(unsigned int k)
61 {
62         return BLI_hash_int_2d(k, 0);
63 }
64
65 BLI_INLINE float BLI_hash_int_01(unsigned int k)
66 {
67         return (float)BLI_hash_int(k) * (1.0f / (float)0xFFFFFFFF);
68 }
69
70 BLI_INLINE void BLI_hash_pointer_to_color(const void *ptr, int *r, int *g, int *b)
71 {
72         size_t val = (size_t)ptr;
73         const size_t hash_a = BLI_hash_int(val & 0x0000ffff);
74         const size_t hash_b = BLI_hash_int((uint)((val & 0xffff0000) >> 32));
75         const size_t hash =
76                 hash_a ^ (hash_b + 0x9e3779b9 + (hash_a << 6) + (hash_a >> 2));
77         *r = (hash & 0xff0000) >> 16;
78         *g = (hash & 0x00ff00) >> 8;
79         *b = hash & 0x0000ff;
80 }
81
82 #ifdef __cplusplus
83 }
84 #endif
85
86 #endif // __BLI_HASH_H__