hash-table.h

Go to the documentation of this file.

// The MIT License (MIT)
// Copyright (c) 2018 Maksim Andrianov
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
#ifndef CDCONTAINERS_INCLUDE_CDCONTAINERS_HASH_TABLE_H
#define CDCONTAINERS_INCLUDE_CDCONTAINERS_HASH_TABLE_H

#include <cdcontainers/common.h>
#include <cdcontainers/hash.h>
#include <cdcontainers/status.h>

#include <assert.h>
#include <stdarg.h>
#include <stdbool.h>
#include <stdlib.h>

struct cdc_hash_table_entry {
  struct cdc_hash_table_entry *next;
  void *key;
  void *value;
  size_t hash;
};

struct cdc_hash_table {
  struct cdc_hash_table_entry *tail;
  struct cdc_hash_table_entry **buckets;
  size_t bcount;
  float load_factor;
  size_t size;
  struct cdc_data_info *dinfo;
};

struct cdc_hash_table_iter {
  struct cdc_hash_table *container;
  struct cdc_hash_table_entry *current;
};
// Base
enum cdc_stat cdc_hash_table_ctor(struct cdc_hash_table **t,
                                  struct cdc_data_info *info);

enum cdc_stat cdc_hash_table_ctorl(struct cdc_hash_table **t,
                                   struct cdc_data_info *info, ...);

enum cdc_stat cdc_hash_table_ctorv(struct cdc_hash_table **t,
                                   struct cdc_data_info *info, va_list args);

enum cdc_stat cdc_hash_table_ctor1(struct cdc_hash_table **t,
                                   struct cdc_data_info *info,
                                   float load_factor);

enum cdc_stat cdc_hash_table_ctorl1(struct cdc_hash_table **t,
                                    struct cdc_data_info *info,
                                    float load_factor, ...);

enum cdc_stat cdc_hash_table_ctorv1(struct cdc_hash_table **t,
                                    struct cdc_data_info *info,
                                    float load_factor, va_list args);

void cdc_hash_table_dtor(struct cdc_hash_table *t);
// Lookup
enum cdc_stat cdc_hash_table_get(struct cdc_hash_table *t, void *key,
                                 void **value);

size_t cdc_hash_table_count(struct cdc_hash_table *t, void *key);

void cdc_hash_table_find(struct cdc_hash_table *t, void *key,
                         struct cdc_hash_table_iter *it);
// Capacity
static inline size_t cdc_hash_table_size(struct cdc_hash_table *t)
{
  assert(t != NULL);

  return t->size;
}

static inline bool cdc_hash_table_empty(struct cdc_hash_table *t)
{
  assert(t != NULL);

  return t->size == 0;
}
// Modifiers
void cdc_hash_table_clear(struct cdc_hash_table *t);

enum cdc_stat cdc_hash_table_insert(struct cdc_hash_table *t, void *key,
                                    void *value, struct cdc_hash_table_iter *it,
                                    bool *inserted);

enum cdc_stat cdc_hash_table_insert_or_assign(struct cdc_hash_table *t,
                                              void *key, void *value,
                                              struct cdc_hash_table_iter *it,
                                              bool *inserted);

size_t cdc_hash_table_erase(struct cdc_hash_table *t, void *key);

void cdc_hash_table_swap(struct cdc_hash_table *a, struct cdc_hash_table *b);
// Iterators
static inline void cdc_hash_table_begin(struct cdc_hash_table *t,
                                        struct cdc_hash_table_iter *it)
{
  assert(t != NULL);
  assert(it != NULL);

  it->container = t;
  it->current = t->buckets[0]->next;
}

static inline void cdc_hash_table_end(struct cdc_hash_table *t,
                                      struct cdc_hash_table_iter *it)
{
  assert(t != NULL);
  assert(it != NULL);

  it->container = t;
  it->current = NULL;
}
// Hash policy
static inline float cdc_hash_table_load_factor(struct cdc_hash_table *t)
{
  assert(t != NULL);

  return (float)t->size / (float)t->bcount;
}

static inline float cdc_hash_table_max_load_factor(struct cdc_hash_table *t)
{
  assert(t != NULL);

  return t->load_factor;
}

static inline void cdc_hash_table_set_max_load_factor(struct cdc_hash_table *t,
                                                      float load_factor)
{
  assert(t != NULL);

  t->load_factor = load_factor;
}

enum cdc_stat cdc_hash_table_rehash(struct cdc_hash_table *t, size_t count);

enum cdc_stat cdc_hash_table_reserve(struct cdc_hash_table *t, size_t count);
// Bucket interface
static inline size_t cdc_hash_table_bucket_count(struct cdc_hash_table *t)
{
  assert(t != NULL);

  return t->bcount;
}
// Iterators
static inline void cdc_hash_table_iter_next(struct cdc_hash_table_iter *it)
{
  assert(it != NULL);

  it->current = it->current->next;
}

static inline bool cdc_hash_table_iter_has_next(struct cdc_hash_table_iter *it)
{
  assert(it != NULL);

  return it->current != NULL;
}

static inline void *cdc_hash_table_iter_key(struct cdc_hash_table_iter *it)
{
  assert(it != NULL);

  return it->current->key;
}

static inline void *cdc_hash_table_iter_value(struct cdc_hash_table_iter *it)
{
  assert(it != NULL);

  return it->current->value;
}

static inline struct cdc_pair cdc_hash_table_iter_key_value(
    struct cdc_hash_table_iter *it)
{
  assert(it != NULL);

  struct cdc_pair pair = {it->current->key, it->current->value};
  return pair;
}

static inline bool cdc_hash_table_iter_is_eq(struct cdc_hash_table_iter *it1,
                                             struct cdc_hash_table_iter *it2)
{
  assert(it1 != NULL);
  assert(it2 != NULL);

  return it1->container == it2->container && it1->current == it2->current;
}
// Short names
#ifdef CDC_USE_SHORT_NAMES
typedef struct cdc_hash_table hash_table_t;
typedef struct cdc_hash_table_iter hash_table_iter_t;
typedef struct cdc_pair_hash_table_iter pair_hash_table_iter_t;
typedef struct cdc_pair_hash_table_iter_bool pair_hash_table_iter_bool_t;

// Base
#define hash_table_ctor(...) cdc_hash_table_ctor(__VA_ARGS__)
#define hash_table_ctorl(...) cdc_hash_table_ctorl(__VA_ARGS__)
#define hash_table_ctorv(...) cdc_hash_table_ctorv(__VA_ARGS__)
#define hash_table_ctor1(...) cdc_hash_table_ctor1(__VA_ARGS__)
#define hash_table_ctorl1(...) cdc_hash_table_ctorl1(__VA_ARGS__)
#define hash_table_ctorv1(...) cdc_hash_table_ctorv1(__VA_ARGS__)
#define hash_table_dtor(...) cdc_hash_table_dtor(__VA_ARGS__)

// Lookup
#define hash_table_get(...) cdc_hash_table_get(__VA_ARGS__)
#define hash_table_count(...) cdc_hash_table_count(__VA_ARGS__)
#define hash_table_find(...) cdc_hash_table_find(__VA_ARGS__)

// Capacity
#define hash_table_size(...) cdc_hash_table_size(__VA_ARGS__)
#define hash_table_empty(...) cdc_hash_table_empty(__VA_ARGS__)

// Modifiers
#define hash_table_clear(...) cdc_hash_table_clear(__VA_ARGS__)
#define hash_table_insert(...) cdc_hash_table_insert(__VA_ARGS__)
#define hash_table_insert_or_assign(...) \
  cdc_hash_table_insert_or_assign(__VA_ARGS__)
#define hash_table_erase(...) cdc_hash_table_erase(__VA_ARGS__)
#define hash_table_swap(...) cdc_hash_table_swap(__VA_ARGS__)

// Iterators
#define hash_table_begin(...) cdc_hash_table_begin(__VA_ARGS__)
#define hash_table_end(...) cdc_hash_table_end(__VA_ARGS__)

// Hash policy
#define hash_table_load_factor(...) cdc_hash_table_load_factor(__VA_ARGS__)
#define hash_table_max_load_factor(...) \
  cdc_hash_table_max_load_factor(__VA_ARGS__)
#define hash_table_set_max_load_factor(...) \
  cdc_hash_table_set_max_load_factor(__VA_ARGS__)
#define hash_table_rehash(...) cdc_hash_table_rehash(__VA_ARGS__)
#define hash_table_reserve(...) cdc_hash_table_reserve(__VA_ARGS__)

// Bucket interface
#define hash_table_bucket_count(...) cdc_hash_table_bucket_count(__VA_ARGS__)

// Iterators
#define hash_table_iter_next(...) cdc_hash_table_iter_next(__VA_ARGS__)
#define hash_table_iter_has_next(...) cdc_hash_table_iter_has_next(__VA_ARGS__)
#define hash_table_iter_key(...) cdc_hash_table_iter_key(__VA_ARGS__)
#define hash_table_iter_value(...) cdc_hash_table_iter_value(__VA_ARGS__)
#define hash_table_iter_key_value(...) \
  cdc_hash_table_iter_key_value(__VA_ARGS__)
#define hash_table_iter_is_eq(...) cdc_hash_table_iter_is_eq(__VA_ARGS__)
#endif

#endif  // CDCONTAINERS_INCLUDE_CDCONTAINERS_HASH_TABLE_H