hash_table.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef HASH_TABLE_H
#define HASH_TABLE_H
 
#include <stdio.h>
 
#include "typedefs.h"
#include "memory_allocations.h"
#include "grassroots_util_library.h"
#include "streams.h"
 
#ifdef __cplusplus
  extern "C" {
#endif
 
 
typedef struct HashBucket
{
  uint32 hb_hashed_key;
 
  const void *hb_key_p;
 
  const void *hb_value_p;
 
  MEM_FLAG hb_owns_key;
 
  MEM_FLAG hb_owns_value;
} HashBucket;
 
 
GRASSROOTS_UTIL_API void FreeHashBucket (HashBucket * const bucket_p);
 
 
GRASSROOTS_UTIL_API HashBucket *CreateHashBuckets (const uint32 num_buckets, const MEM_FLAG key_mem_flag, const MEM_FLAG value_mem_flag);
 
 
GRASSROOTS_UTIL_API HashBucket *CreateDeepCopyHashBuckets (const uint32 num_buckets);
 
 
GRASSROOTS_UTIL_API HashBucket *CreateShallowCopyHashBuckets (const uint32 num_buckets);
 
 
GRASSROOTS_UTIL_API HashBucket *CreateShadowUseHashBuckets (const uint32 num_buckets);
 
 
GRASSROOTS_UTIL_API HashBucket *CreateDeepCopyKeysShallowCopyValueHashBuckets (const uint32 num_buckets);
 
 
 
typedef struct HashTable
{
  uint32 ht_size;
 
  uint32 ht_capacity;
 
  uint8 ht_load;
 
  uint32 ht_load_limit;
 
  HashBucket *ht_buckets_p;
 
  uint32 (*ht_hash_fn) (const void *);
 
  HashBucket *(*ht_create_buckets_fn) (const uint32 num_buckets);
 
  void (*ht_free_bucket_fn) (HashBucket * const bucket_p);
 
  bool (*ht_fill_bucket_fn) (HashBucket * const bucket_p, const void * const key_p, const void * const value_p);
 
  bool (*ht_compare_keys_fn) (const void * const bucket_key_p, const void * const key_p);
 
  void (*ht_print_bucket_fn) (const HashBucket * const bucket_p, OutputStream * const stream_p);
 
  bool (*ht_save_bucket_fn) (const HashBucket * const bucket_p, FILE *out_f);
 
} HashTable;
 
 
GRASSROOTS_UTIL_API HashTable *AllocateHashTable (const uint32 initial_size,
  const uint8 load_percentage,
  uint32 (*hash_fn) (const void * const key_p),
  HashBucket *(*create_buckets_fn) (const uint32 num_buckets),
  void (*free_bucket_fn) (HashBucket * const bucket_p),
  bool (*fill_bucket_fn) (HashBucket * const bucket_p, const void * const key_p, const void * const value_p),
  bool (*compare_keys_fn) (const void * const bucket_key_p, const void * const key_p),
  void (*print_bucket_fn) (const HashBucket * const bucket_p, OutputStream * const stream_p),
  bool (*save_bucket_fn) (const HashBucket * const bucket_p, FILE *out_f));
 
 
GRASSROOTS_UTIL_API void FreeHashTable (HashTable * const hash_table_p);
 
 
GRASSROOTS_UTIL_API void ClearHashTable (HashTable * const hash_table_p);
 
 
GRASSROOTS_UTIL_API bool IsValidHashBucket (const HashBucket * const bucket_p);
 
 
GRASSROOTS_UTIL_API bool PutInHashTable (HashTable * const hash_table_p, const void * const key_p, const void * const value_p);
 
 
GRASSROOTS_UTIL_API const void *GetFromHashTable (const HashTable * const hash_table_p, const void * const key_p);
 
GRASSROOTS_UTIL_API void **GetKeysIndexFromHashTable (const HashTable * const hash_table_p);
 
GRASSROOTS_UTIL_API void FreeKeysIndex (void **index_pp);
 
GRASSROOTS_UTIL_API void RemoveFromHashTable (HashTable * const hash_table_p, const void * const key_p);
 
 
GRASSROOTS_UTIL_API void PrintHashTable (const HashTable * const hash_table_p, OutputStream * const stream_p);
 
 
GRASSROOTS_UTIL_API HashTable *CopyHashTable (const HashTable * const src_table_p, const bool deep_copy_if_necessary);
 
 
GRASSROOTS_UTIL_API bool SaveHashTable (const HashTable * const table_p, const char * const filename_s, int (*compare_fn) (const void *v0_p, const void *v1_p));
 
 
GRASSROOTS_UTIL_API bool LoadHashTable (HashTable * const table_p, char *current_path_s, const char * const filename_s);
 
 
GRASSROOTS_UTIL_API uint32 GetHashTableSize (const HashTable * const table_p);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef HASH_TABLE_H */