white_box_code.h

Zobrazit dokumentaci tohoto souboru.

//======= Copyright (c) 2025, FIT VUT Brno, All rights reserved. ============//
//
// Purpose:     White Box - hash map class code
//
// $NoKeywords: $ivs_project_1 $white_box_code.h
// $Authors:    Karel Ondřej <ondrej@fit.vutbr.cz>
//              Martin Dočekal <idocekal@fit.vutbr.cz>
// $Date:       $2025-02-19
//============================================================================//
#ifndef HASH_MAP_H_
#define HASH_MAP_H_
 
#include <stdlib.h>
#include <string.h>     
#include <stddef.h>
#include <stdbool.h>
 
#define HASH_MAP_INIT_SIZE 8                    
 
#define HASH_MAP_PERTURB_SHIFT 5                
 
#define HASH_MAP_REALLOCATION_THRESHOLD 3/5.
 
#define HASH_FUNCTION_PARAM_A 1794967309        
 
#define HASH_FUNCTION_PARAM_B 7                 
 
// Informace pro C++ překladač, aby použil "C" linker pro následující funkce.
extern "C" {
 
/*******************************************************************************
 * Inicializace, deinicializace & alokace paměti
 ******************************************************************************/
typedef enum {
    OK,                     
    MEMORY_ERROR,           
    VALUE_ERROR,            
    KEY_ERROR,              
    KEY_ALREADY_EXISTS      
} hash_map_state_code_t;
 
typedef struct hash_map_item
{
    char* key;                  
    size_t hash;                
    int value;                  
    struct hash_map_item* next; 
    struct hash_map_item* prev; 
} hash_map_item_t;
 
typedef struct hash_map
{
    hash_map_item_t** index;    
    hash_map_item_t* first;     
    hash_map_item_t* last;      
 
    hash_map_item_t* dummy;     
    size_t allocated;           
    size_t used;                
} hash_map_t;
 
/*******************************************************************************
 * Inicializace, deinicializace & alokace paměti
 ******************************************************************************/
hash_map_t* hash_map_ctor();
 
void hash_map_dtor(hash_map_t* self);
 
void hash_map_clear(hash_map_t* self);
 
hash_map_state_code_t hash_map_reserve(hash_map_t* self, size_t size);
 
/*******************************************************************************
 * Metody pro přístup k hašovací tabulce
 ******************************************************************************/
size_t hash_map_size(hash_map_t* self);
 
size_t hash_map_capacity(hash_map_t* self);
 
bool hash_map_contains(hash_map_t* self, const char* key);
 
hash_map_state_code_t hash_map_put(hash_map_t* self, const char* key, 
                                   int value);
 
hash_map_state_code_t hash_map_get(hash_map_t* self, const char* key, 
                                   int* value);
 
hash_map_state_code_t hash_map_pop(hash_map_t* self, const char* key, 
                                   int* value);
 
hash_map_state_code_t hash_map_remove(hash_map_t* self, const char* key);
 
}       // extern "C" ending
 
#endif  // HASH_MAP_H_
 
/*** Konec souboru white_box_code.h ***/