cdcontainers  0.1.1
Library of data containers and collections for C programming language.
Functions

Functions

enum cdc_stat cdc_hash_table_get (struct cdc_hash_table *t, void *key, void **value)
 Returns a value that is mapped to a key. If the key does not exist, then NULL will return. More...
 
size_t cdc_hash_table_count (struct cdc_hash_table *t, void *key)
 Returns the number of elements with key that compares equal to the specified argument key, which is either 1 or 0 since this container does not allow duplicates. More...
 
void cdc_hash_table_find (struct cdc_hash_table *t, void *key, struct cdc_hash_table_iter *it)
 Finds an element with key equivalent to key. More...
 

Detailed Description

Function Documentation

◆ cdc_hash_table_get()

enum cdc_stat cdc_hash_table_get ( struct cdc_hash_table t,
void *  key,
void **  value 
)

Returns a value that is mapped to a key. If the key does not exist, then NULL will return.

Parameters
[in]t- cdc_hash_table
[in]key- key of the element to find
[out]value- pinter to the value that is mapped to a key.
Returns
CDC_STATUS_OK if the key is found, CDC_STATUS_NOT_FOUND otherwise.

◆ cdc_hash_table_count()

size_t cdc_hash_table_count ( struct cdc_hash_table t,
void *  key 
)

Returns the number of elements with key that compares equal to the specified argument key, which is either 1 or 0 since this container does not allow duplicates.

Parameters
[in]t- cdc_hash_table
[in]key- key value of the elements to count
Returns
number of elements with key key, that is either 1 or 0.

◆ cdc_hash_table_find()

void cdc_hash_table_find ( struct cdc_hash_table t,
void *  key,
struct cdc_hash_table_iter it 
)

Finds an element with key equivalent to key.

Parameters
[in]t- cdc_hash_table
[in]key- key value of the element to search for
[out]it- pointer will be recorded iterator to an element with key equivalent to key. If no such element is found, past-the-end iterator is returned.