hello-algo/ja/codes/python/chapter_hashing/hash_map_chaining.py

"""
File: hash_map_chaining.py
Created Time: 2023-06-13
Author: krahets (krahets@163.com)
"""

import sys
from pathlib import Path

sys.path.append(str(Path(__file__).parent.parent))
from chapter_hashing.array_hash_map import Pair


class HashMapChaining:
    """チェイン法のハッシュテーブル"""

    def __init__(self):
        """コンストラクタ"""
        self.size = 0  # キーと値のペアの数
        self.capacity = 4  # ハッシュテーブルの容量
        self.load_thres = 2.0 / 3.0  # 容量の拡張を開始する負荷率のしきい値
        self.extend_ratio = 2  # 容量の拡張倍率
        self.buckets = [[] for _ in range(self.capacity)]  # バケット配列

    def hash_func(self, key: int) -> int:
        """ハッシュ関数"""
        return key % self.capacity

    def load_factor(self) -> float:
        """負荷率"""
        return self.size / self.capacity

    def get(self, key: int) -> str | None:
        """取得操作"""
        index = self.hash_func(key)
        bucket = self.buckets[index]
        # バケットを走査し、key が見つかったら対応する val を返す
        for pair in bucket:
            if pair.key == key:
                return pair.val
        # key が見つからなかった場合、None を返す
        return None

    def put(self, key: int, val: str):
        """追加操作"""
        # 負荷率がしきい値を超えた場合、容量を拡張する
        if self.load_factor() > self.load_thres:
            self.extend()
        index = self.hash_func(key)
        bucket = self.buckets[index]
        # バケットを走査し、指定された key が見つかったら、対応する val を更新して戻る
        for pair in bucket:
            if pair.key == key:
                pair.val = val
                return
        # key が存在しない場合、キーと値のペアを末尾に追加する
        pair = Pair(key, val)
        bucket.append(pair)
        self.size += 1

    def remove(self, key: int):
        """削除操作"""
        index = self.hash_func(key)
        bucket = self.buckets[index]
        # バケットを走査し、キーと値のペアを削除する
        for pair in bucket:
            if pair.key == key:
                bucket.remove(pair)
                self.size -= 1
                break

    def extend(self):
        """ハッシュテーブルの容量を拡張する"""
        # 元のハッシュテーブルを一時保存する
        buckets = self.buckets
        # 拡張後の新しいハッシュテーブルを初期化する
        self.capacity *= self.extend_ratio
        self.buckets = [[] for _ in range(self.capacity)]
        self.size = 0
        # キーと値のペアを元のハッシュテーブルから新しいハッシュテーブルに移す
        for bucket in buckets:
            for pair in bucket:
                self.put(pair.key, pair.val)

    def print(self):
        """ハッシュテーブルを表示する"""
        for bucket in self.buckets:
            res = []
            for pair in bucket:
                res.append(str(pair.key) + " -> " + pair.val)
            print(res)


"""実行用コード"""
if __name__ == "__main__":
    # ハッシュテーブルを初期化する
    hashmap = HashMapChaining()

    # 追加操作
    # ハッシュテーブルにキーと値のペア (key, value) を追加する
    hashmap.put(12836, "小哈")
    hashmap.put(15937, "小啰")
    hashmap.put(16750, "小算")
    hashmap.put(13276, "小法")
    hashmap.put(10583, "小鸭")
    print("\n追加後のハッシュテーブル\n[Key1 -> Value1, Key2 -> Value2, ...]")
    hashmap.print()

    # 取得操作
    # ハッシュテーブルにキー key を渡し、値 value を取得する
    name = hashmap.get(13276)
    print("\n学生番号 13276 に対応する氏名は " + name)

    # 削除操作
    # ハッシュテーブルからキーと値のペア (key, value) を削除する
    hashmap.remove(12836)
    print("\n12836 を削除した後のハッシュテーブル\n[Key1 -> Value1, Key2 -> Value2, ...]")
    hashmap.print()