Coin: hash.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

hash.h
1#ifndef CC_HASH_H
2#define CC_HASH_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36/* This interface is OBSOLETE -- please do not use it in your
37 application code, as it will be removed from Coin 3 and onwards. */
38
39#include <stdlib.h>
40#include <Inventor/C/basic.h>
41
42#if defined(COIN_INTERNAL) && !defined(COIN_ALLOW_CC_HASH)
43#error prefer cc_dict over cc_hash for internal code
44#endif /* COIN_INTERNAL */
45
46#ifdef __cplusplus
47extern "C" {
48#endif /* __cplusplus */
49
50 typedef uintptr_t cc_hash_key;
51 typedef struct cc_hash cc_hash;
52 typedef cc_hash_key cc_hash_func(const cc_hash_key key);
53 typedef void cc_hash_apply_func(cc_hash_key key, void * val, void * closure);
54
55 COIN_DLL_API cc_hash * cc_hash_construct(unsigned int size, float loadfactor);
56 COIN_DLL_API void cc_hash_destruct(cc_hash * ht);
57 COIN_DLL_API void cc_hash_clear(cc_hash * ht);
58
59 COIN_DLL_API SbBool cc_hash_put(cc_hash * ht, cc_hash_key key, void * val);
60 COIN_DLL_API SbBool cc_hash_get(cc_hash * ht, cc_hash_key key, void ** val);
61 COIN_DLL_API SbBool cc_hash_remove(cc_hash * ht, cc_hash_key key);
62 COIN_DLL_API void cc_hash_apply(cc_hash * ht, cc_hash_apply_func * func, void * closure);
63
64 COIN_DLL_API unsigned int cc_hash_get_num_elements(cc_hash * ht);
65
66 COIN_DLL_API void cc_hash_set_hash_func(cc_hash * ht, cc_hash_func * func);
67 COIN_DLL_API void cc_hash_print_stat(cc_hash * ht);
68
69/* ********************************************************************** */
70
71#ifdef __cplusplus
72} /* extern "C" */
73#endif /* __cplusplus */
74
75#endif /* ! CC_HASH_H */