/
hash_map.h
99 lines (88 loc) · 2.63 KB
/
hash_map.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/**
* @file collections/hash_map.h
*
* @section License
* Copyright (C) 2014-2016, Erik Moqvist
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* This file is part of the Simba project.
*/
#ifndef __COLLECTIONS_HASH_MAP_H__
#define __COLLECTIONS_HASH_MAP_H__
#include "simba.h"
typedef int (*hash_function_t)(long key);
struct hash_map_entry_t {
struct hash_map_entry_t *next_p;
long key;
void *value_p;
};
struct hash_map_bucket_t {
struct hash_map_entry_t *list_p;
};
struct hash_map_t {
struct hash_map_bucket_t *buckets_p;
size_t buckets_max;
struct hash_map_entry_t *entries_p;
hash_function_t hash;
};
/**
* Initialize hash map with given parameters.
*
* @param[in,out] self_p Initialized hash map.
* @param[in] buckets_p Array of buckets.
* @param[in] buckets_max Number of entries in `buckets_p`.
* @param[in] entries_p Array of empty entries.
* @param[in] entries_max Number of entries in `entries_p`.
* @param[in] hash Hash function.
*
* @return zero(0) or negative error code.
*/
int hash_map_init(struct hash_map_t *self_p,
struct hash_map_bucket_t *buckets_p,
size_t buckets_max,
struct hash_map_entry_t *entries_p,
size_t entries_max,
hash_function_t hash);
/**
* Add given key-value pair into hash map. Overwrites old value if the
* key is already present in map.
*
* @param[in] self_p Initialized hash map.
* @param[in] key Key to hash.
* @param[in] value_p Value to insert for key.
*
* @return zero(0) or negative error code.
*/
int hash_map_add(struct hash_map_t *self_p,
long key,
void *value_p);
/**
* Remove given key from hash map.
*
* @param[in] self_p Initialized hash map.
* @param[in] key Key to hash.
*
* @return zero(0) or negative error code.
*/
int hash_map_remove(struct hash_map_t *self_p,
long key);
/**
* Get value for given key.
*
* @param[in] self_p Initialized hash map.
* @param[in] key Key to hash.
*
* @return Value for key or NULL if key was not found in the map.
*/
void *hash_map_get(struct hash_map_t *self_p,
long key);
#endif