Begin HashTable

Author: bitdove

README.md

@@ -29,6 +29,8 @@ Remember that each data has its own trade-offs. And you need to pay attention mo
   * `B` Doubly Linked List
 * `B` [Queue](data-structures/Queue)
 * `B` [Stack](data-structures/Stack)
+* `B` [Hash Table](data-structures/HashTable)
+
 
 
 ## Algorithms

README.zh-CN.md

@@ -26,6 +26,8 @@
   * `B` 双向链表
 * `B` [队列](data-structures/Queue)
 * `B` [栈](data-structures/Stack)
+* `B` [哈希表](data-structures/HashTable)
+
 
 
 

data-structures/HashTable/CMakeLists.txt

@@ -0,0 +1,21 @@
+# Specify the minimum version of CMake required
+cmake_minimum_required(VERSION 3.10)
+
+# Project name and version
+project(HashTableProject VERSION 1.0)
+
+# Set C++ standard
+set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD_REQUIRED True)
+
+# Include directories
+include_directories(include)
+
+# Output executables to the 'bin' directory
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/../bin)
+
+# Add the test executable
+add_executable(test_HashTable __test__/test_HashTable.cpp)
+
+# Link the HashTable library to the test executable
+target_link_libraries(test_HashTable)

data-structures/HashTable/README.md

@@ -0,0 +1,25 @@
+# 哈希表
+
+在计算中, 一个  **哈希表(hash table 或hash map)**  是一种实现 *关联数组(associative array)*
+的抽象数据类型, 该结构可以将 *键映射到值*。
+
+哈希表使用 *哈希函数/散列函数* 来计算一个值在数组或桶(buckets)中或槽(slots)中对应的索引,可使用该索引找到所需的值。
+
+理想情况下,散列函数将为每个键分配给一个唯一的桶(bucket),但是大多数哈希表设计采用不完美的散列函数,这可能会导致"哈希冲突(hash collisions)",也就是散列函数为多个键(key)生成了相同的索引,这种碰撞必须
+以某种方式进行处理。
+
+
+![Hash Table](./assets/hash-table.jpeg)
+
+*Made with [okso.app](https://okso.app)*
+
+通过单独的链接解决哈希冲突
+
+![Hash Collision](./assets/collision-resolution.jpeg)
+
+*Made with [okso.app](https://okso.app)*
+
+## 参考
+
+- [Wikipedia](https://en.wikipedia.org/wiki/Hash_table)
+- [YouTube](https://www.youtube.com/watch?v=shs0KM3wKv8&index=4&list=PLLXdhg_r2hKA7DPDsunoDZ-Z769jWn4R8)

data-structures/HashTable/__test__/test_HashTable.cpp

@@ -0,0 +1 @@
+#include "../include/HashTable.h"

data-structures/HashTable/assets/collision-resolution.jpeg

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+# Create the build directory if it doesn't exist
+if [ ! -d "build" ]; then
+  mkdir build
+fi
+
+# Run CMake in the build directory
+cd build
+cmake ..
+
+# Build the project using make
+make
+
+# Return to the project root directory
+cd ..
+
+# Inform the user where the executable can be found
+echo "Build complete. Executable located in the ./bin directory."

data-structures/HashTable/assets/hash-table.jpeg

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# Remove build and bin directories
+rm -rf build
+rm -rf bin
+
+echo "Clean complete. Build and bin directories removed."

data-structures/HashTable/build.sh

@@ -0,0 +1,47 @@
+#ifndef HASHTABLE_H
+#define HASHTABLE_H
+
+#include "../../Array/include/Vector.h"
+#include "../../LinkedList/include/SinglyLinkedList.h"
+#include <cstddef>
+#include <stdexcept>
+
+const size_t DefautBucketsCounts = 11;
+
+template <typename Key, typename Value>
+class HashTable{
+  public:
+    HashTable();
+    ~HashTable();
+  public:
+    // Capacity
+    bool empty() {return _size == 0;}
+    size_t size() {return _size;}
+    // Element access
+    Value& at(const Key& key);
+    Value& operator[](const Key& key);
+    // Element lookup
+    size_t count(const Key& key) const;
+    // Modifiers
+    void insert(const Key& key, const Value& value);
+    size_t erase(const Key& key);
+    void clear();
+    // Buckets
+    size_t buckets_count() const;
+    size_t bucket_size(const size_t n) const;
+    size_t bucket(const Key& key) const;
+  private:
+    struct _KVNode{
+      Key _key;
+      Value _value;
+    };
+    Vector<SinglyLinkedList<_KVNode>> _buckets;
+    size_t _size;
+};
+
+// Constructor and Destructor
+template <typename Key, typename Value>
+HashTable<Key, Value>::HashTable() : _buckets(DefautBucketsCounts), _size(0) {}
+
+
+#endif // HASHTABLE