hashmap.h File Reference

hashmap interface More...

#include <types.h>
#include <memory.h>
#include <iterator.h>

Macros
#define	___HASHMAP_H   0
#define	hashmap_new_with_hkg(c, hkg)
	create hashmap with key generator, uses default key comparator
#define	hashmap_new_with_hkc(c, hkc)
	create hashmap with key comparator, uses default key generator
#define	hashmap_new_with_heap(heap, c)
	create hashmap with key generator and key comparator, uses default memory heap
#define	hashmap_new(c)
	create hashmap, uses default key generator and key comparator
#define	hashmap_string(c)
	create hashmap with string key, uses string key generator and key comparator
#define	hashmap_integer(c)
	create hashmap with integer key, uses integer key generator and key comparator
#define	hashmap_integer_with_heap(heap, c)
	create hashmap with integer key, uses integer key generator and key comparator

Typedefs
typedef struct hashmap_t	hashmap_t
	opaque hashmap type
typedef uint64_t(*	hashmap_key_generator_f) (const void *item)
	hashmap key generator function type
typedef int8_t(*	hashmap_key_comparator_f) (const void *item1, const void *item2)
	hashmap key comparator function type

Functions
hashmap_t *	hashmap_new_with_hkg_with_hkc (memory_heap_t *heap, uint64_t capacity, hashmap_key_generator_f hkg, hashmap_key_comparator_f hkc)
	create hashmap with key generator and key comparator
hashmap_t *	hashmap_string_with_heap (memory_heap_t *heap, uint64_t capacity)
	create hashmap with string key, uses string key generator and key comparator
boolean_t	hashmap_destroy (hashmap_t *hm)
	destroy hashmap
const void *	hashmap_put (hashmap_t *hm, const void *key, const void *item)
	put item to hashmap
const void *	hashmap_get (hashmap_t *hm, const void *key)
	get item from hashmap
const void *	hashmap_get_key (hashmap_t *hm, const void *key)
	get key from hashmap
boolean_t	hashmap_exists (hashmap_t *hm, const void *key)
	check existence of key in hashmap
boolean_t	hashmap_delete (hashmap_t *hm, const void *key)
	delete item from hashmap
uint64_t	hashmap_size (hashmap_t *hm)
	get size of hashmap
iterator_t *	hashmap_iterator_create (hashmap_t *hm)
	create iterator of hashmap

Detailed Description

hashmap interface

This work is licensed under TURNSTONE OS Public License. Please read and understand latest version of Licence.

Macro Definition Documentation

___HASHMAP_H

#define ___HASHMAP_H   0

macro for avoiding multiple inclusion

hashmap_integer

#define hashmap_integer

(

c

)

Value:

hashmap_new(c)

create hashmap with integer key, uses integer key generator and key comparator

Parameters

[in]

c

capacity of hashmap

Returns

hashmap

hashmap_integer_with_heap

#define hashmap_integer_with_heap	(		heap,
			c )

Value:

hashmap_new_with_heap(heap, c)

create hashmap with integer key, uses integer key generator and key comparator

Parameters

[in]	heap	memory heap
[in]	c	capacity of hashmap

Returns

hashmap

hashmap_new

#define hashmap_new

(

c

)

Value:

hashmap_new_with_heap(NULL, c)

create hashmap, uses default key generator and key comparator

Parameters

[in]

c

capacity of hashmap

Returns

hashmap

hashmap_new_with_heap

#define hashmap_new_with_heap	(		heap,
			c )

Value:

hashmap_new_with_hkg_with_hkc(heap, c, NULL, NULL)

create hashmap with key generator and key comparator, uses default memory heap

Parameters

[in]	heap	memory heap
[in]	c	capacity of hashmap

Returns

hashmap

hashmap_new_with_hkc

#define hashmap_new_with_hkc	(		c,
			hkc )

Value:

hashmap_new_with_hkg_with_hkc(NULL, c, NULL, hkc)

create hashmap with key comparator, uses default key generator

Parameters

[in]	c	capacity of hashmap
[in]	hkc	key comparator function

Returns

hashmap

hashmap_new_with_hkg

#define hashmap_new_with_hkg	(		c,
			hkg )

Value:

hashmap_new_with_hkg_with_hkc(NULL, c, hkg, NULL)

create hashmap with key generator, uses default key comparator

Parameters

[in]	c	capacity of hashmap
[in]	hkg	key generator function

Returns

hashmap

hashmap_string

#define hashmap_string

(

c

)

Value:

hashmap_string_with_heap(NULL, c)

create hashmap with string key, uses string key generator and key comparator

Parameters

[in]

c

capacity of hashmap

Returns

hashmap

Typedef Documentation

hashmap_key_comparator_f

typedef int8_t(* hashmap_key_comparator_f) (const void *item1, const void *item2)

hashmap key comparator function type

Parameters

[in]	item1	item to compare
[in]	item2	item to compare

Returns

0 if item1 == item2, -1 if item1 < item2, 1 if item1 > item2

hashmap_key_generator_f

typedef uint64_t(* hashmap_key_generator_f) (const void *item)

hashmap key generator function type

Parameters

[in]

item

item to generate key

Returns

key generated from item

Function Documentation

hashmap_delete()

boolean_t hashmap_delete	(	hashmap_t *	hm,
		const void *	key )

delete item from hashmap

Parameters

[in]	hm	hashmap to delete item
[in]	key	key of item

Returns

true if logically same key exists and deleted successfully, false otherwise

hashmap_destroy()

boolean_t hashmap_destroy

(

hashmap_t *

hm

)

destroy hashmap

Parameters

[in]

hm

hashmap to destroy

Returns

true if hashmap is destroyed successfully, false otherwise

hashmap_exists()

boolean_t hashmap_exists	(	hashmap_t *	hm,
		const void *	key )

check existence of key in hashmap

Parameters

[in]	hm	hashmap to check existence
[in]	key	key of item

Returns

true if logically same key exists, false otherwise

hashmap_get()

const void * hashmap_get	(	hashmap_t *	hm,
		const void *	key )

get item from hashmap

Parameters

[in]	hm	hashmap to get item
[in]	key	key of item

Returns

item if same key exists, NULL otherwise

hashmap_get_key()

const void * hashmap_get_key	(	hashmap_t *	hm,
		const void *	key )

get key from hashmap

Parameters

[in]	hm	hashmap to get key
[in]	key	key of item

Returns

real key if input key logically exists, NULL otherwise

hashmap_iterator_create()

iterator_t * hashmap_iterator_create

(

hashmap_t *

hm

)

create iterator of hashmap

Parameters

[in]

hm

hashmap to create iterator

Returns

iterator of hashmap

hashmap_new_with_hkg_with_hkc()

hashmap_t * hashmap_new_with_hkg_with_hkc	(	memory_heap_t *	heap,
		uint64_t	capacity,
		hashmap_key_generator_f	hkg,
		hashmap_key_comparator_f	hkc )

create hashmap with key generator and key comparator

Parameters

[in]	heap	memory heap
[in]	capacity	capacity of hashmap
[in]	hkg	key generator function
[in]	hkc	key comparator function

Returns

hashmap

hashmap_put()

const void * hashmap_put	(	hashmap_t *	hm,
		const void *	key,
		const void *	item )

put item to hashmap

Parameters

[in]	hm	hashmap to put item
[in]	key	key of item
[in]	item	item to put

Returns

old item if same key exists and put successfully, NULL otherwise

hashmap_size()

uint64_t hashmap_size

(

hashmap_t *

hm

)

get size of hashmap

Parameters

[in]

hm

hashmap to get size

Returns

size of hashmap

hashmap_string_with_heap()

hashmap_t * hashmap_string_with_heap	(	memory_heap_t *	heap,
		uint64_t	capacity )

create hashmap with string key, uses string key generator and key comparator

Parameters

[in]	heap	memory heap
[in]	capacity	capacity of hashmap

Returns

hashmap