aboutsummaryrefslogtreecommitdiff
path: root/src/string_map.cpp
blob: f7ecc4accef3cc38076579c88aaf45df0de9ed65 (plain)
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
struct StringHashKey {
	u32    hash;
	String string;

	operator String() const noexcept {
		return this->string;
	}
	operator String const &() const noexcept {
		return this->string;
	}
};

gb_internal gb_inline StringHashKey string_hash_string(String const &s) {
	StringHashKey hash_key = {};
	hash_key.hash = fnv32a(s.text, s.len);
	hash_key.string = s;
	return hash_key;
}


gb_internal gb_inline bool string_hash_key_equal(StringHashKey const &a, StringHashKey const &b) {
	if (a.hash == b.hash) {
		// NOTE(bill): If two string's hashes collide, compare the strings themselves
		return a.string == b.string;
	}
	return false;
}

template <typename T>
struct StringMapEntry {
	StringHashKey key;
	MapIndex      next;
	T             value;
};

template <typename T>
struct StringMap {
	Slice<MapIndex>           hashes;
	Array<StringMapEntry<T> > entries;
};


template <typename T> gb_internal void string_map_init             (StringMap<T> *h, isize capacity = 16);
template <typename T> gb_internal void string_map_destroy          (StringMap<T> *h);

template <typename T> gb_internal T *  string_map_get              (StringMap<T> *h, char const *key);
template <typename T> gb_internal T *  string_map_get              (StringMap<T> *h, String const &key);
template <typename T> gb_internal T *  string_map_get              (StringMap<T> *h, StringHashKey const &key);

template <typename T> gb_internal T &  string_map_must_get         (StringMap<T> *h, char const *key);
template <typename T> gb_internal T &  string_map_must_get         (StringMap<T> *h, String const &key);
template <typename T> gb_internal T &  string_map_must_get         (StringMap<T> *h, StringHashKey const &key);

template <typename T> gb_internal void string_map_set              (StringMap<T> *h, char const *key,   T const &value);
template <typename T> gb_internal void string_map_set              (StringMap<T> *h, String const &key, T const &value);
template <typename T> gb_internal void string_map_set              (StringMap<T> *h, StringHashKey const &key, T const &value);

// template <typename T> gb_internal void string_map_remove           (StringMap<T> *h, StringHashKey const &key);
template <typename T> gb_internal void string_map_clear            (StringMap<T> *h);
template <typename T> gb_internal void string_map_grow             (StringMap<T> *h);
template <typename T> gb_internal void string_map_reserve          (StringMap<T> *h, isize new_count);

gb_internal gbAllocator string_map_allocator(void) {
	return heap_allocator();
}

template <typename T>
gb_internal gb_inline void string_map_init(StringMap<T> *h, isize capacity) {
	capacity = next_pow2_isize(capacity);
	slice_init(&h->hashes,  string_map_allocator(), capacity);
	array_init(&h->entries, string_map_allocator(), 0, capacity);
	for (isize i = 0; i < capacity; i++) {
		h->hashes.data[i] = MAP_SENTINEL;
	}
}

template <typename T>
gb_internal gb_inline void string_map_destroy(StringMap<T> *h) {
	if (h->entries.allocator.proc == nullptr) {
		h->entries.allocator = string_map_allocator();
	}
	slice_free(&h->hashes, h->entries.allocator);
	array_free(&h->entries);
}

template <typename T>
gb_internal MapIndex string_map__add_entry(StringMap<T> *h, StringHashKey const &key) {
	StringMapEntry<T> e = {};
	e.key = key;
	e.next = MAP_SENTINEL;
	array_add(&h->entries, e);
	return cast(MapIndex)(h->entries.count-1);
}

template <typename T>
gb_internal MapFindResult string_map__find(StringMap<T> *h, StringHashKey const &key) {
	MapFindResult fr = {MAP_SENTINEL, MAP_SENTINEL, MAP_SENTINEL};
	if (h->hashes.count != 0) {
		fr.hash_index = cast(MapIndex)(key.hash & (h->hashes.count-1));
		fr.entry_index = h->hashes.data[fr.hash_index];
		while (fr.entry_index != MAP_SENTINEL) {
			if (string_hash_key_equal(h->entries.data[fr.entry_index].key, key)) {
				return fr;
			}
			fr.entry_prev = fr.entry_index;
			fr.entry_index = h->entries.data[fr.entry_index].next;
		}
	}
	return fr;
}

template <typename T>
gb_internal MapFindResult string_map__find_from_entry(StringMap<T> *h, StringMapEntry<T> *e) {
	MapFindResult fr = {MAP_SENTINEL, MAP_SENTINEL, MAP_SENTINEL};
	if (h->hashes.count != 0) {
		fr.hash_index  = cast(MapIndex)(e->key.hash & (h->hashes.count-1));
		fr.entry_index = h->hashes.data[fr.hash_index];
		while (fr.entry_index != MAP_SENTINEL) {
			if (&h->entries.data[fr.entry_index] == e) {
				return fr;
			}
			fr.entry_prev = fr.entry_index;
			fr.entry_index = h->entries.data[fr.entry_index].next;
		}
	}
	return fr;
}

template <typename T>
gb_internal b32 string_map__full(StringMap<T> *h) {
	return 0.75f * h->hashes.count <= h->entries.count;
}

template <typename T>
gb_inline void string_map_grow(StringMap<T> *h) {
	isize new_count = gb_max(h->hashes.count<<1, 16);
	string_map_reserve(h, new_count);
}


template <typename T>
gb_internal void string_map_reset_entries(StringMap<T> *h) {
	for (isize i = 0; i < h->hashes.count; i++) {
		h->hashes.data[i] = MAP_SENTINEL;
	}
	for (isize i = 0; i < h->entries.count; i++) {
		MapFindResult fr;
		StringMapEntry<T> *e = &h->entries.data[i];
		e->next = MAP_SENTINEL;
		fr = string_map__find_from_entry(h, e);
		if (fr.entry_prev == MAP_SENTINEL) {
			h->hashes[fr.hash_index] = cast(MapIndex)i;
		} else {
			h->entries[fr.entry_prev].next = cast(MapIndex)i;
		}
	}
}

template <typename T>
gb_internal void string_map_reserve(StringMap<T> *h, isize cap) {
	if (h->entries.allocator.proc == nullptr) {
		h->entries.allocator = string_map_allocator();
	}
	array_reserve(&h->entries, cap);
	if (h->entries.count*2 < h->hashes.count) {
		return;
	}
	slice_resize(&h->hashes, h->entries.allocator, cap*2);
	string_map_reset_entries(h);
}

template <typename T>
gb_internal T *string_map_get(StringMap<T> *h, StringHashKey const &key) {
	MapFindResult fr = {MAP_SENTINEL, MAP_SENTINEL, MAP_SENTINEL};
	if (h->hashes.count != 0) {
		fr.hash_index = cast(MapIndex)(key.hash & (h->hashes.count-1));
		fr.entry_index = h->hashes.data[fr.hash_index];
		while (fr.entry_index != MAP_SENTINEL) {
			auto *entry = &h->entries.data[fr.entry_index];
			if (string_hash_key_equal(entry->key, key)) {
				return &entry->value;
			}
			fr.entry_prev = fr.entry_index;
			fr.entry_index = entry->next;
		}
	}
	return nullptr;
}

template <typename T>
gb_internal gb_inline T *string_map_get(StringMap<T> *h, String const &key) {
	return string_map_get(h, string_hash_string(key));
}

template <typename T>
gb_internal gb_inline T *string_map_get(StringMap<T> *h, char const *key) {
	return string_map_get(h, string_hash_string(make_string_c(key)));
}

template <typename T>
gb_internal T &string_map_must_get(StringMap<T> *h, StringHashKey const &key) {
	isize index = string_map__find(h, key).entry_index;
	GB_ASSERT(index != MAP_SENTINEL);
	return h->entries.data[index].value;
}

template <typename T>
gb_internal gb_inline T &string_map_must_get(StringMap<T> *h, String const &key) {
	return string_map_must_get(h, string_hash_string(key));
}

template <typename T>
gb_internal gb_inline T &string_map_must_get(StringMap<T> *h, char const *key) {
	return string_map_must_get(h, string_hash_string(make_string_c(key)));
}

template <typename T>
gb_internal void string_map_set(StringMap<T> *h, StringHashKey const &key, T const &value) {
	MapIndex index;
	MapFindResult fr;
	if (h->hashes.count == 0) {
		string_map_grow(h);
	}
	fr = string_map__find(h, key);
	if (fr.entry_index != MAP_SENTINEL) {
		index = fr.entry_index;
	} else {
		index = string_map__add_entry(h, key);
		if (fr.entry_prev != MAP_SENTINEL) {
			h->entries.data[fr.entry_prev].next = index;
		} else {
			h->hashes.data[fr.hash_index] = index;
		}
	}
	h->entries.data[index].value = value;

	if (string_map__full(h)) {
		string_map_grow(h);
	}
}

template <typename T>
gb_internal gb_inline void string_map_set(StringMap<T> *h, String const &key, T const &value) {
	string_map_set(h, string_hash_string(key), value);
}

template <typename T>
gb_internal gb_inline void string_map_set(StringMap<T> *h, char const *key, T const &value) {
	string_map_set(h, string_hash_string(make_string_c(key)), value);
}


// template <typename T>
// gb_internal void string_map__erase(StringMap<T> *h, MapFindResult const &fr) {
// 	MapFindResult last;
// 	if (fr.entry_prev == MAP_SENTINEL) {
// 		h->hashes.data[fr.hash_index] = h->entries.data[fr.entry_index].next;
// 	} else {
// 		h->entries.data[fr.entry_prev].next = h->entries.data[fr.entry_index].next;
// 	}
// 	if (fr.entry_index == h->entries.count-1) {
// 		array_pop(&h->entries);
// 		return;
// 	}
// 	h->entries.data[fr.entry_index] = h->entries.data[h->entries.count-1];
// 	last = string_map__find(h, h->entries.data[fr.entry_index].key);
// 	if (last.entry_prev != MAP_SENTINEL) {
// 		h->entries.data[last.entry_prev].next = fr.entry_index;
// 	} else {
// 		h->hashes.data[last.hash_index] = fr.entry_index;
// 	}
// }

// template <typename T>
// gb_internal void string_map_remove(StringMap<T> *h, StringHashKey const &key) {
// 	MapFindResult fr = string_map__find(h, key);
// 	if (fr.entry_index != MAP_SENTINEL) {
// 		string_map__erase(h, fr);
// 	}
// }

template <typename T>
gb_internal gb_inline void string_map_clear(StringMap<T> *h) {
	array_clear(&h->entries);
	for (isize i = 0; i < h->hashes.count; i++) {
		h->hashes.data[i] = MAP_SENTINEL;
	}
}



template <typename T>
gb_internal StringMapEntry<T> *begin(StringMap<T> &m) noexcept {
	return m.entries.data;
}
template <typename T>
gb_internal StringMapEntry<T> const *begin(StringMap<T> const &m) noexcept {
	return m.entries.data;
}


template <typename T>
gb_internal StringMapEntry<T> *end(StringMap<T> &m) {
	return m.entries.data + m.entries.count;
}

template <typename T>
gb_internal StringMapEntry<T> const *end(StringMap<T> const &m) noexcept {
	return m.entries.data + m.entries.count;
}