src/cx/hash_key.h@c49104015a6b
src/cx/hash_key.h
Sun, 06 Nov 2022 14:46:59 +0100
- author
- Mike Becker <universe@uap-core.de>
- date
- Sun, 06 Nov 2022 14:46:59 +0100
- changeset 603
- c49104015a6b
- parent 563
- 69a83fad8a35
- child 604
- 056e5f592d84
- permissions
- -rw-r--r--
fix missing const in cx_hash_key signature
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28 /**
29 * \file hash_key.h
30 * \brief Interface for map implementations.
31 * \author Mike Becker
32 * \author Olaf Wintermann
33 * \version 3.0
34 * \copyright 2-Clause BSD License
35 */
38 #ifndef UCX_HASH_KEY_H
39 #define UCX_HASH_KEY_H
41 #include "stddef.h"
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
47 /** Internal structure for a key within a hash map. */
48 struct cx_hash_key_s {
49 /** The key data. */
50 union {
51 unsigned char *bytes;
52 unsigned char const *cbytes;
53 char *str;
54 char const *cstr;
55 void *obj;
56 void const *cobj;
57 } data;
58 /**
59 * The key data length.
60 */
61 size_t len;
62 /** The hash value of the key data. */
63 unsigned hash;
64 };
66 /**
67 * Type for a hash key.
68 */
69 typedef struct cx_hash_key_s CxHashKey;
71 /**
72 * Computes a murmur hash-2.
73 *
74 * You need to initialize data and len in the key struct.
75 * The hash is then directly written to that struct.
76 *
77 * @param key the key, the hash shall be computed for
78 */
79 void cx_hash_murmur(CxHashKey *key);
81 /**
82 * Computes a hash key from a string.
83 *
84 * The string needs to be zero-terminated.
85 *
86 * @param str the string
87 * @return the hash key
88 */
89 __attribute__((__warn_unused_result__))
90 CxHashKey cx_hash_key_str(char const *str);
92 /**
93 * Computes a hash key from a byte array.
94 *
95 * @param bytes the array
96 * @param len the length
97 * @return the hash key
98 */
99 __attribute__((__warn_unused_result__))
100 CxHashKey cx_hash_key_bytes(
101 unsigned char const *bytes,
102 size_t len
103 );
105 /**
106 * Computes a hash key for an arbitrary object.
107 *
108 * The computation uses the in-memory representation that might not be
109 * the same on different platforms. Therefore, this hash should not be
110 * used for data exchange with different machines.
111 *
112 * @param obj a pointer to an arbitrary object
113 * @param len the length of object in memory
114 * @return the hash key
115 */
116 __attribute__((__warn_unused_result__))
117 CxHashKey cx_hash_key(
118 void const *obj,
119 size_t len
120 );
122 #ifdef __cplusplus
123 } // extern "C"
124 #endif
126 #endif /* UCX_HASH_KEY_H */
