pascal_hash_table.h

/* This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/>.
 */

/* Code: */

#ifndef OPIC_HASH_PASCAL_ROBIN_HOOD_HASH
#define OPIC_HASH_PASCAL_ROBIN_HOOD_HASH 1

#include <stdbool.h>
#include "opic/common/op_macros.h"
#include "opic/op_malloc.h"
#include "op_hash.h"

OP_BEGIN_DECLS

typedef struct PascalHashTable PascalHashTable;

PascalHashTable* PHNew(OPHeap* heap, uint64_t num_objects, double load,
                       size_t key_inline_size, size_t valsize);

void PHDestroy(PascalHashTable* rhh);

bool PHInsertCustom(PascalHashTable* rhh, OPHash hasher,
                    void* key, size_t keysize, void* val);

bool PHUpsertCustom(PascalHashTable* rhh, OPHash hasher,
                    void* key, size_t keysize, void** val_ref,
                    bool* is_duplicate);

void* PHGetCustom(PascalHashTable* rhh, OPHash hasher,
                  void* key, size_t keysize);

void* PHDeleteCustom(PascalHashTable* rhh, OPHash hasher,
                     void* key, size_t keysize);

static inline bool
PHInsert(PascalHashTable* rhh, void* key, size_t keysize, void* val)
{
  return PHInsertCustom(rhh, OPDefaultHash, key, keysize, val);
}

static inline bool
PHUpsert(PascalHashTable* rhh, void* key, size_t keysize,
         void** val_ref, bool* is_duplicate)
{
  return PHUpsertCustom(rhh, OPDefaultHash, key, keysize,
                        val_ref, is_duplicate);
}

static inline void*
PHGet(PascalHashTable* rhh, void* key, size_t keysize)
{
  return PHGetCustom(rhh, OPDefaultHash, key, keysize);
}

static inline void*
PHDelete(PascalHashTable* rhh, void* key, size_t keysize)
{
  return PHDeleteCustom(rhh, OPDefaultHash, key, keysize);
}

uint64_t PHObjcnt(PascalHashTable* rhh);

uint64_t PHCapacity(PascalHashTable* rhh);

size_t PHKeyInlineSize(PascalHashTable* rhh);

size_t PHValSize(PascalHashTable* rhh);

void PHIterate(PascalHashTable* rhh,
               OPHashIterator iterator, void* context);

void PHPrintStat(PascalHashTable* rhh);

uint32_t PHMaxProbe(PascalHashTable* rhh);

uint32_t PHProbeStat(PascalHashTable* rhh, uint32_t idx);

OP_END_DECLS

#endif
/* pascal_robin_hood.h ends here */