Muldersoft/LibHashSet
Muldersoft/LibHashSet
1
0
Fork 0
Code Releases 4 Activity

Implemented the hash_set_dump() function.

Browse Source
This commit is contained in:
LoRd_MuldeR 2022-11-27 20:23:49 +01:00
parent fb8fdd00a0
commit e58e4d1061
6 changed files with 110 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -394,6 +394,63 @@ On success, this function returns *zero*. On error, the appropriate error code i
* `EFAULT`
Something else went wrong. This usually indicates an internal error and is *not* supposed to happen.
### hash_set_dump()
Dump the current status and content of all "slots" of the hash set.
```C
errno_t hash_set_dump(
const hash_set_t *const instance,
int (*callback)(const size_t index, const int status, const uint32_t value)
);
```
#### Parameters
* `instance`
A pointer to the hash set instance to be examined, as returned by the [hash_set_create()](#hash_set_create) function.
* `capacity`
A pointer to the callback function that will be invoked once for every "slot" of the hash set.
```C
int callback(
const size_t index,
const int status,
const uint32_t value
);
```
##### Parameters
* `index`
The index of the current "slot" within the hash set.
* `status`
Indicates the status of the current "slot":
- `0` – slot is *unused*
- `1` – slot is *valid*
- `2` – slot is *deleted*
* `value`
The value that is stored at the current "slot" index.
##### Return value
If the function returns *zero*, the iteration is cancelled; otherwise the iteration continues.
#### Return value
On success, this function returns *zero*. On error, the appropriate error code is returned. Possible error codes include:
* `EINVAL`
An invalid argument was given, e.g. `instance` was set to `NULL`.
* `ECANCELED`
The operation was cancelled by the calling application.
* `EFAULT`
Something else went wrong. This usually indicates an internal error and is *not* supposed to happen.
Thread Safety
-------------

5
libhashset/include/hash_set.h
View File

@ -67,7 +67,10 @@ HASHSET_API size_t hash_set_size64(const hash_set64_t *const instance);
HASHSET_API errno_t hash_set_info32(const hash_set32_t *const instance, size_t *const capacity, size_t *const valid, size_t *const deleted, size_t *const limit);
HASHSET_API errno_t hash_set_info64(const hash_set64_t *const instance, size_t *const capacity, size_t *const valid, size_t *const deleted, size_t *const limit);
HASHSET_API errno_t hash_set_dump32(const hash_set32_t *const instance, int (*const callback)(const size_t index, const int status, const uint32_t value));
HASHSET_API errno_t hash_set_dump64(const hash_set64_t *const instance, int (*const callback)(const size_t index, const int status, const uint64_t value));
#ifdef __cplusplus
}
#endif
#endif
#endif /* _LIBHASHSET_INCLUDED */

2
libhashset/src/common.h
View File

@ -119,4 +119,4 @@ static INLINE void clear_flag(uint8_t* const flags, const size_t index)
flags[index / 8U] &= ~(UINT8_C(1) << (index % 8U));
}
#endif
#endif /* _LIBHASHSET_COMMON_INCLUDED */

73
libhashset/src/generic.h
View File

@ -3,24 +3,17 @@
/* This work has been released under the CC0 1.0 Universal license! */
/******************************************************************************/
#ifndef _LIBHASHSET_COMMON_INCLUDED
#error File "common.h" must be included first!
#endif
#ifndef _LIBHASHSET_GENERIC_INCLUDED
#define _LIBHASHSET_GENERIC_INCLUDED
#ifndef NAME_SUFFIX
#error NAME_SUFFIX must be defined!
#endif
#ifndef SET_TYPE
#error SET_TYPE must be defined!
#endif
#ifndef VALUE_TYPE
#error VALUE_TYPE must be defined!
#endif
#define MAKE_NAME(X) NAME_GLUE(X,NAME_SUFFIX)
#include "common.h"
/* ------------------------------------------------- */
/* Data types */
/* ------------------------------------------------- */
@ -29,7 +22,7 @@
struct DATA_STRUCT
{
VALUE_TYPE *values;
value_t *values;
uint8_t *used, *deleted;
size_t capacity;
};
@ -55,7 +48,7 @@ static FORCE_INLINE void hash_update(uint64_t *const hash, uint64_t value)
while (value >>= CHAR_BIT);
}
static INLINE uint64_t hash_compute(const uint64_t i, const VALUE_TYPE value)
static INLINE uint64_t hash_compute(const uint64_t i, const value_t value)
{
uint64_t hash = UINT64_C(14695981039346656037);
hash_update(&hash, i);
@ -76,7 +69,7 @@ static INLINE bool_t alloc_data(struct DATA_STRUCT *const data, const size_t cap
{
zero_memory(data, 1U, sizeof(struct DATA_STRUCT));
data->values = (VALUE_TYPE*) calloc(capacity, sizeof(VALUE_TYPE));
data->values = (value_t*) calloc(capacity, sizeof(value_t));
if (!data->values)
{
return FALSE;
@ -118,7 +111,7 @@ static INLINE void free_data(struct DATA_STRUCT *const data)
#define INDEX(X) ((size_t)((X) % data->capacity))
static INLINE bool_t find_slot(const struct DATA_STRUCT *const data, const VALUE_TYPE value, size_t *const index_out, bool_t *const reused_out)
static INLINE bool_t find_slot(const struct DATA_STRUCT *const data, const value_t value, size_t *const index_out, bool_t *const reused_out)
{
uint64_t loop = 0U;
bool_t is_saved = FALSE;
@ -155,7 +148,7 @@ static INLINE bool_t find_slot(const struct DATA_STRUCT *const data, const VALUE
return FALSE;
}
static INLINE void put_value(struct DATA_STRUCT *const data, const size_t index, const VALUE_TYPE value, const bool_t reusing)
static INLINE void put_value(struct DATA_STRUCT *const data, const size_t index, const value_t value, const bool_t reusing)
{
data->values[index] = value;
if (reusing)
@ -182,7 +175,7 @@ static size_t INLINE compute_limit(const size_t capacity, const double load_fact
return limit;
}
static INLINE errno_t rebuild_set(SET_TYPE *const instance, const size_t new_capacity)
static INLINE errno_t rebuild_set(hash_set_t *const instance, const size_t new_capacity)
{
struct DATA_STRUCT temp;
size_t index, k;
@ -201,7 +194,7 @@ static INLINE errno_t rebuild_set(SET_TYPE *const instance, const size_t new_cap
{
if (IS_VALID(instance->data, k))
{
const VALUE_TYPE value = instance->data.values[k];
const value_t value = instance->data.values[k];
if (find_slot(&temp, value, &index, NULL))
{
free_data(&temp);
@ -223,9 +216,9 @@ static INLINE errno_t rebuild_set(SET_TYPE *const instance, const size_t new_cap
/* PUBLIC FUNCTIONS */
/* ========================================================================= */
SET_TYPE* MAKE_NAME(hash_set_create)(const size_t initial_capacity, const double load_factor)
hash_set_t* MAKE_NAME(hash_set_create)(const size_t initial_capacity, const double load_factor)
{
SET_TYPE* instance = (SET_TYPE*) calloc(1U, sizeof(SET_TYPE));
hash_set_t* instance = (hash_set_t*) calloc(1U, sizeof(hash_set_t));
if (!instance)
{
return NULL;
@ -243,17 +236,17 @@ SET_TYPE* MAKE_NAME(hash_set_create)(const size_t initial_capacity, const double
return instance;
}
void MAKE_NAME(hash_set_destroy)(SET_TYPE *instance)
void MAKE_NAME(hash_set_destroy)(hash_set_t *instance)
{
if (instance)
{
free_data(&instance->data);
zero_memory(instance, 1U, sizeof(SET_TYPE));
zero_memory(instance, 1U, sizeof(hash_set_t));
SAFE_FREE(instance);
}
}
errno_t MAKE_NAME(hash_set_insert)(SET_TYPE *const instance, const VALUE_TYPE value)
errno_t MAKE_NAME(hash_set_insert)(hash_set_t *const instance, const value_t value)
{
size_t index;
bool_t slot_reused;
@ -292,7 +285,7 @@ errno_t MAKE_NAME(hash_set_insert)(SET_TYPE *const instance, const VALUE_TYPE va
return 0;
}
errno_t MAKE_NAME(hash_set_contains)(const SET_TYPE *const instance, const VALUE_TYPE value)
errno_t MAKE_NAME(hash_set_contains)(const hash_set_t *const instance, const value_t value)
{
if ((!instance) || (!instance->data.values))
{
@ -302,7 +295,7 @@ errno_t MAKE_NAME(hash_set_contains)(const SET_TYPE *const instance, const VALUE
return (instance->valid && find_slot(&instance->data, value, NULL, NULL)) ? 0 : ENOENT;
}
errno_t MAKE_NAME(hash_set_remove)(SET_TYPE *const instance, const VALUE_TYPE value)
errno_t MAKE_NAME(hash_set_remove)(hash_set_t *const instance, const value_t value)
{
size_t index;
@ -338,7 +331,7 @@ errno_t MAKE_NAME(hash_set_remove)(SET_TYPE *const instance, const VALUE_TYPE va
return 0;
}
errno_t MAKE_NAME(hash_set_clear)(SET_TYPE *const instance)
errno_t MAKE_NAME(hash_set_clear)(hash_set_t *const instance)
{
if ((!instance) || (!instance->data.values))
{
@ -369,7 +362,7 @@ errno_t MAKE_NAME(hash_set_clear)(SET_TYPE *const instance)
return 0;
}
errno_t MAKE_NAME(hash_set_iterate)(const SET_TYPE *const instance, uintptr_t *const cursor, VALUE_TYPE *const value)
errno_t MAKE_NAME(hash_set_iterate)(const hash_set_t *const instance, uintptr_t *const cursor, value_t *const value)
{
size_t index;
@ -395,12 +388,12 @@ errno_t MAKE_NAME(hash_set_iterate)(const SET_TYPE *const instance, uintptr_t *c
return ENOENT;
}
size_t MAKE_NAME(hash_set_size)(const SET_TYPE *const instance)
size_t MAKE_NAME(hash_set_size)(const hash_set_t *const instance)
{
return instance ? instance->valid : 0U;
}
errno_t MAKE_NAME(hash_set_info)(const SET_TYPE *const instance, size_t *const capacity, size_t *const valid, size_t *const deleted, size_t *const limit)
errno_t MAKE_NAME(hash_set_info)(const hash_set_t *const instance, size_t *const capacity, size_t *const valid, size_t *const deleted, size_t *const limit)
{
if ((!instance) || (!instance->data.values))
{
@ -426,3 +419,25 @@ errno_t MAKE_NAME(hash_set_info)(const SET_TYPE *const instance, size_t *const c
return 0;
}
HASHSET_API errno_t MAKE_NAME(hash_set_dump)(const hash_set_t *const instance, int (*const callback)(const size_t index, const int status, const value_t value))
{
size_t index;
if ((!instance) || (!instance->data.values))
{
return EINVAL;
}
for (index = 0U; index < instance->data.capacity; ++index)
{
if (!callback(index, get_flag(instance->data.used, index) ? (get_flag(instance->data.deleted, index) ? 2 : 1) : 0, instance->data.values[index]))
{
return ECANCELED;
}
}
return 0;
}
#endif /* _LIBHASHSET_GENERIC_INCLUDED */

4
libhashset/src/hash_set_32.c
View File

@ -7,7 +7,7 @@
#include "common.h"
#define NAME_SUFFIX 32
#define SET_TYPE hash_set32_t
#define VALUE_TYPE uint32_t
typedef hash_set32_t hash_set_t;
typedef uint32_t value_t;
#include "generic.h"

5
libhashset/src/hash_set_64.c
View File

@ -4,10 +4,9 @@
/******************************************************************************/
#include <hash_set.h>
#include "common.h"
#define NAME_SUFFIX 64
#define SET_TYPE hash_set64_t
#define VALUE_TYPE uint64_t
typedef hash_set64_t hash_set_t;
typedef uint64_t value_t;
#include "generic.h"