数据结构-LRU缓存（C语言实现）

遇到困难，不必慌张，正是成长的时候，耐心一点！

前言

本篇文章主要是为了记录实现LRU缓存的方法和思考的过程。

一、题目介绍

请你设计并实现一个满足 LRU (最近最少使用) 缓存约束的数据结构。
实现 LRUCache 类：
LRUCache(int capacity) 以正整数作为容量 capacity 初始化 LRU 缓存
int get(int key) 如果关键字 key 存在于缓存中，则返回关键字的值，否则返回 -1 。
void put(int key, int value) 如果关键字 key 已经存在，则变更其数据值 value ；
如果不存在，则向缓存中插入该组 key-value 。
如果插入操作导致关键字数量超过 capacity ，则应该逐出最久未使用的关键字。
函数 get 和 put 必须以 O(1) 的平均时间复杂度运行。

示例：
输入
[“LRUCache”, “put”, “put”, “get”, “put”, “get”, “put”, “get”, “get”, “get”]
[[2], [1, 1], [2, 2], [1], [3, 3], [2], [4, 4], [1], [3], [4]]
输出
[null, null, null, 1, null, -1, null, -1, 3, 4]
解释
LRUCache lRUCache = new LRUCache(2);
lRUCache.put(1, 1); // 缓存是 {1=1}
lRUCache.put(2, 2); // 缓存是 {1=1, 2=2}
lRUCache.get(1); // 返回 1
lRUCache.put(3, 3); // 该操作会使得关键字 2 作废，缓存是 {1=1, 3=3}
lRUCache.get(2); // 返回 -1 (未找到)
lRUCache.put(4, 4); // 该操作会使得关键字 1 作废，缓存是 {4=4, 3=3}
lRUCache.get(1); // 返回 -1 (未找到)
lRUCache.get(3); // 返回 3
lRUCache.get(4); // 返回 4

提示:
1 <= capacity <= 3000
0 <= key <= 10000
0 <= value <= 105
最多调用 2 * 105 次 get 和 put

下面是本人的一些废话，不感兴趣可直接看实现过程

看完题目，看到函数 get 和 put 必须以 O(1) 的平均时间复杂度运行，第一反应是顺序存储的随机存取才可以实现O(1)的时间复杂度，也就是说一定会有一块连续的存储空间存储数据，且大小为capacity。可以把key对应连续的存储空间的下标，但是看到提示里面的key的范围超出了capacity的范围，那如何在让key在[0,capacity]循环呢？脑子直接想到了循环队列的取余法，因为最近用循环队列比较频繁。
但是，经过取余后，还是会造成出现重复的key，该怎们解决呢？突然想到数据结构里面的散列表的碰撞的处理，立马去看关于散列表的介绍，以前没学的东西，现在又冒出来找我了。
看了以后，觉得很神奇，原来取余法是散列函数的一种，并使用频繁的一种。然后又看了关于碰撞的处理，书上介绍两种，第一种叫开地址法，第二种方法叫拉链法。
解决了碰撞问题，那么如何实现最近最少使用，一想到这是关于链表的题目，慢慢想到了循环单链表，头插法实现最近使用，而尾结点一定是最少使用，也就是当缓存空间达到capacity时，需要删除的。但是写了一半代码，发现当访问结点为尾结点时，需要更改尾结点，也就是需要尾结点的前驱。我知道，在单链表中，寻找某个结点前驱时间复杂度是O(n)，不符合题意，立马把代码删除。
经过思考，心情里变得比较烦躁，但又不想看题解，因为想着现在正是考验我的时候，想着这道题一定想要教会我什么。尝试让自己变得冷静，不断地翻开数据结构这本书，看到双向链表，哎，这不就是为了解决以O(1)时间复杂度访问某个结点前驱的问题嘛！为什么没有马上想到，是因为平时做的题目都是单链表，双向链表用的太少了…
以上问题都解决了后，刚开始使用开地址法的线性探查法解决碰撞时，发现最后几个测试用例超时了，但是，说明思路是对的，因为线性探访的最坏情况的时间复杂度就是O(n)。
然后改为使用了拉链法，写代码用的时间不多，调试用了很多时间，最终，在不放弃的情况下，终于找到了代码的某处错误。真是太不容易了，因为常规测试用例通过了，在一些复杂的测试用例没通过，又无法一步一步的调试，只能不断地阅读代码，最后发现是在某个很隐秘且常规测试用例很难覆盖的地方，我当场麻了…
所幸，最后还是一步一步的写出来了，还是非常开心的，感觉时间花的太值了！

二、实现过程

2.1 实现原理

实现原理：散列表+双向链表
散列表解决了key重复问题，并解决函数 get 和 put 必须以 O(1) 的平均时间复杂度运行的问题
双向链表解决了最近使用和最少使用的问题，头插法解决最近使用，尾结点解决了最少使用
结构图如图2.1所示：
在这里插入图片描述

图2.1 LRU原理图

2.2 实现思路

2.2.1 双向链表

为了方便双向链表的插入和删除操作，可以使用两个辅助结点，一个伪头部和一个伪尾部，实现了每个真实结点都有前驱和后继
在这里插入图片描述

图2.2.1 双向链表

2.2.2 散列表

这里主要想介绍解决碰撞问题的拉链法。
设散列表的大小为m,使用拉链法需要建立m条链表，所有散列地址相同的元素放在同一条链表中，如果某个地址中没有存放任何元素，则对应的链表为空链表。设关键码key，根据散列函数h计算出h(key)，即可确定第h(key)条链表，然后在该链表进行插入和删除及检索操作。
在本题中，散列函数为取余法，散列表的大小为capacity
$\,\%\, capacity$
在本题中, $ha s h Key = h (k ey), ha s hVa l u e = ha s h T ab l e [ha s h Key]$
如下图所示
在这里插入图片描述

图2.2.1 散列表

2.3 代码实现

本篇文章的代码使用C语言实现

2.3.1 结构定义

//双向链表结点
struct DoubleNode
{
    int key;        //真实的key
    int value;
    struct DoubleNode* llink;       //双向链表的前驱
    struct DoubleNode* rlink;      //双向链表的后继
};

//双向链表类型
//为了方便操作，使用两个伪结点
struct DoubleList
{
    struct DoubleNode* dummyHead;    //双向链表的伪头部
    struct DoubleNode* dummyRear;    //双向链表的伪尾部  
};

//哈希结点的定义
//相同hashKey构成的链表的结点类型
struct HashNode
{
    struct DoubleNode* address;         //指向双向链表的某个结点
    struct HashNode*   next;
};


//使用双向链表
//保存双向链表的头结点
//散列函数       取余法 
//解决地址碰撞   拉链法   
typedef struct
{
    struct DoubleList* doubleList;      //双向链表
    struct HashNode**  hashTable;       //哈希表
    int capacity;                       //缓存空间大小
    int curCapacty;                     //已用空间
} LRUCache;

2.3.2 双向链表操作实现

//双向链表的操作
//初始化双向链表
void initDoubleList(struct DoubleList* doubleList)
{
    doubleList->dummyHead = (struct DoubleNode*)calloc(1, sizeof(struct DoubleNode));  //初始化双向链表的伪头部
    doubleList->dummyRear = (struct DoubleNode*)calloc(1, sizeof(struct DoubleNode));  //初始化双向链表的伪尾部
    //头和尾互连
    doubleList->dummyHead->rlink = doubleList->dummyRear;                              
    doubleList->dummyRear->llink = doubleList->dummyHead;
}

//将某个结点向双向链表中的第一个结点前执行插入操作
void insertNodeToDoubleListFirst(struct DoubleList* doubleList, struct DoubleNode* node)
{
    node->rlink = doubleList->dummyHead->rlink;
    node->llink = doubleList->dummyHead;
    doubleList->dummyHead->rlink->llink = node;
    doubleList->dummyHead->rlink = node;
}

//将node结点移动到双向链表的第一个结点
void moveNodeToHead(struct DoubleList* doubleList, struct DoubleNode* node)
{   
    //从双向链表中断开
    node->llink->rlink = node->rlink;
    node->rlink->llink = node->llink;
    //将断开的结点重新插入到双向链表的伪头部后
    insertNodeToDoubleListFirst(doubleList, node);
}

2.3.3 实现散列表的操作

//哈希表的操作
//散列函数
//取余法
int hashFunc(int key, int m)
{
    return key % m;
}

//在hashTable查看对应的hashKey的结点是否指向已存在的key
struct HashNode* getHashNode(struct HashNode** hashTable, int hashKey, int key)
{
    for (struct HashNode* hashValue = hashTable[hashKey]; hashValue != NULL; hashValue = hashValue->next)
    {
        if (hashValue->address->key == key)
        {
            return hashValue;
        }
    }
    return NULL;
}


//往哈希表插入一个HashNode(头插法)
void insertHashNodeToHashTable(struct HashNode** hashTable, int hashKey,struct HashNode* hnode)
{   
    hnode->next = hashTable[hashKey];
    hashTable[hashKey] = hnode; 
}

//从哈希表hashTable[hashKey]->address == dnode的结点断开在之前的链表
struct HashNode* deleteHashNodeFromHashTable(struct HashNode** hashTable, int hashKey, struct DoubleNode* dnode)
{
    struct HashNode* pre_hashNode = hashTable[hashKey];
    struct HashNode* freeNode = NULL;
    if (pre_hashNode->address == dnode)   //如果第一个为删除结点，则将hashTable[hashKey] = pre_hashNode->next
    {
        freeNode = pre_hashNode;
        hashTable[hashKey] = pre_hashNode->next;
    }
    else                                //否则需要寻找address为dnode的前驱结点
    {
        while (pre_hashNode->next->address != dnode)
        {
            pre_hashNode = pre_hashNode->next;
        }
        freeNode = pre_hashNode->next;
        pre_hashNode->next = pre_hashNode->next->next;
    }
    return freeNode;
}

2.3.4 内存释放代码

//释放hashTable的内存
void hashTableNodeListFree(struct HashNode** hashTable, int capacity)
{  

    for(int hashKey = 0; hashKey < capacity; hashKey++)
    {
       //释放相同hashKey的链表结点内存
       for(struct HashNode* head = hashTable[hashKey]; head != NULL; NULL)
       {
            struct HashNode* freeNode = head;
            head = head->next;
            free(freeNode);
       }
    }
    free(hashTable);
}

//释放双向链表的内存
void doubleNodeListFree(struct DoubleList* doubleList)
{   
    //释放双向链表每一个数据结点空间
    for(struct DoubleNode* head = doubleList->dummyHead; head != NULL; NULL)
    {
        struct DoubleNode* freeNode = head;
        head = head->rlink;
        free(freeNode);
    }
    //释放双向链表的头结点空间
    free(doubleList);
}

2.3.5 题目代码实现

LRUCache* lRUCacheCreate(int capacity)
{
    LRUCache* obj = (LRUCache*)calloc(1, sizeof(LRUCache));
    obj->capacity = capacity;
    obj->hashTable = (struct HashNode**)calloc(capacity, sizeof(struct HashNode*));
    obj->doubleList = (struct DoubleList*)calloc(1, sizeof(struct DoubleList));  //初始化双向链表
    initDoubleList(obj->doubleList);
    return obj;
}

int lRUCacheGet(LRUCache* obj, int key)
{
    int hashKey = hashFunc(key, obj->capacity);
    struct HashNode* hashValue = getHashNode(obj->hashTable, hashKey, key);
    if(hashValue != NULL)
    {
        moveNodeToHead(obj->doubleList, hashValue->address);
        return hashValue->address->value;
    }
    return -1;
}

void lRUCachePut(LRUCache* obj, int key, int value)
{
    int hashKey = hashFunc(key, obj->capacity);
    //查看当前的hashKey是否存在
    //存在则修改value
    struct HashNode* hashValue = getHashNode(obj->hashTable, hashKey, key);
    if(hashValue != NULL)
    {
        hashValue->address->value = value;
        moveNodeToHead(obj->doubleList, hashValue->address);
        return;
    }

    //当前的key对应的hashKey不存在
    //则将当前的key插入到hashTable中
    if (obj->curCapacty < obj->capacity)   //缓存空间未满  
    {   
        //新建一个双向链表的结点
        struct DoubleNode* dnode = (struct DoubleNode*)calloc(1, sizeof(struct DoubleNode));
        dnode->key = key;
        dnode->value = value;

        //新建一个HashNode
        struct HashNode* hnode = (struct HashNode*)calloc(1, sizeof(struct HashNode));
        hnode->address = dnode;    
        //插入到哈希表
        insertHashNodeToHashTable(obj->hashTable, hashKey, hnode);

        //将dnode插入到双链表的头
        insertNodeToDoubleListFirst(obj->doubleList, dnode);
        obj->curCapacty++;
    }
    else    //缓存空间已满  重用旧的结点->需要切断旧结点以前的联系->重新赋值->新生
    {
        //逐出最近未使用的关键字，即双向链表的尾结点
        struct DoubleNode* dnode = obj->doubleList->dummyRear->llink;
        //重置dnode在hashTable的位置
        struct HashNode* hnode =  deleteHashNodeFromHashTable(obj->hashTable, hashFunc(dnode->key,obj->capacity), dnode);
        //将dnode重新赋值
        dnode->key    = key;
        dnode->value  = value;
        //使用原来的哈希结点，则 hnode->address = dnode 可省略
        insertHashNodeToHashTable(obj->hashTable, hashKey,hnode);
        moveNodeToHead(obj->doubleList, dnode);
    }
}

void lRUCacheFree(LRUCache* obj)
{
    //先释放双向链表的内存
    doubleNodeListFree(obj->doubleList);
    //释放哈希表的内存
    hashTableNodeListFree(obj->hashTable, obj->capacity);
    //释放缓存的头结点内存
    free(obj);
}