带头双向循环链表的增删查改等基本操作的实现

一些链表的概念和链表分类在 单链表中有所介绍，本篇文章主要介绍链表中比较复杂的带头双向循环链表。

介绍

带头双向循环链表是结构最复杂的，通常单独存储数据。虽然结构复杂，但是因为结构的复杂，使其实现非常简单，不需要同单链表考虑很多东西。

逻辑结构

带头双向循环链表的实现

我们把函数的声明、实现和测试分别写在三个文件。
分别是：dList.h / dList.c / test.c

函数的声明

dList.h:

#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include <stdbool.h>

//类型重定义，后期如果修改，在这里修改一下，就可以修改全工程
typedef int LTDataType;

typedef struct ListNode
{
	struct ListNode* prev;    //该节点前面的节点地址
	struct ListNode* next;    //该节点后面的节点地址
	LTDataType data;
}LTNode;


//带头双向循环链表的销毁
void LTDestroy(LTNode* phead);

//创建带头双向循环链表节点
LTNode* BuyLTNode(LTDataType x);

//带头双向循环链表的初始化
LTNode* LTInit();

//带头双向循环链表打印
void LTPrint(LTNode* phead);

//带头双向循环链表尾插
void LTPushBack(LTNode* phead, LTDataType x);

//带头双向循环链表尾删
void LTPopBack(LTNode* phead);

//带头双向循环链表头插
void LTPushFront(LTNode* phead, LTDataType x);

//带头双向循环链表头删
void LTPopFront(LTNode* phead);

//带头双向循环链表查找
LTNode* LTFind(LTNode* phead, LTDataType x);

//带头双向循环链表在pos的前面进行插入
void LTInsert(LTNode* pos, LTDataType x);

//带头双向循环链表删除pos节点
void LTErase(LTNode* pos);

接口的实现

这里需要注意对双向链表的初始化，需要专门写一个函数，这个初始化是较为复杂的，需要自己指向自己。
dList.c:

#include "dList.h"

//新建一个节点，并返回节点的地址
LTNode* BuyLTNode(LTDataType x)
{
	LTNode* node = (LTNode*)malloc(sizeof(LTNode));
	if (NULL == node)
	{
		perror("BuyLTNode::malloc");
		//退出程序，也可以使用
		//return NULL;
		exit(-1);
	}
	node->data = x;
	
	//在创建节点的时候要对前后指针置空，便于下面使用
	node->next = NULL;
	node->prev = NULL;
	return node;
}

//初始化
LTNode* LTInit()
{
	//这里我们用-1先申请一个头结点，然后prev和next都指向自己
	//仅仅是初始化，无关用什么值去申请一个节点。
	LTNode* phead = BuyLTNode(-1);

	//prev和next两个指针都要指向自己(head)
	phead->prev= phead;
	phead->next = phead;
	
	return phead;
}

//打印
void LTPrint(LTNode* phead)
{
	assert(phead);

	printf("<=> head <=> ");
	LTNode* cur = phead->next;
	while (cur != phead)
	{
		printf("%d <=> ", cur->data);
		cur = cur->next;
	}
	printf("\n");
}

//销毁
void LTDestroy(LTNode* phead)
{
	assert(phead);

	//因为每个节点都是malloc出来的，所以要遍历释放
	LTNode* cur = phead->next;
	while (cur != phead)
	{
		LTNode* next = cur->next;
		free(cur);
		cur = next;
	}

	//这里phead也是在初始化中malloc出来的，所以也要释放
	free(phead);
	//这里不需要对phead置空，使用人员置空。
	//因为这里传的一级指针，是传值传递，形参的改变不影响实参
	//phead = NULL;
}

//尾插
void LTPushBack(LTNode* phead, LTDataType x)
{
	assert(phead);

	LTNode* newnode = BuyLTNode(x);
	
	//插入时，要注意顺序。如果重新定义一个变量，就不需要注意顺序了。这里没有定义新的变量，所以要注意顺序。
	newnode->prev = phead->prev;
	phead->prev->next = newnode;

	newnode->next = phead;
	phead->prev = newnode;

}

//判断链表是否为空，是否就只有一个哨兵位
bool LTEmpty(LTNode* phead)
{
	assert(phead);
	//返回布尔值，为真返回true，为假返回false
	return phead->next == phead;
}

//尾删
void LTPopBack(LTNode* phead)
{
	assert(phead);
	assert(!LTEmpty(phead));

	//保存尾节点地址
	LTNode* tail = phead->prev;
	
	//链接新的尾节点和哨兵位
	phead->prev = tail->prev;
	tail->prev->next = phead;
	
	//释放原来的尾节点
	free(tail);
	tail = NULL;
}

//头插
void LTPushFront(LTNode* phead, LTDataType x)
{
	assert(phead);
	LTNode* newnode = BuyLTNode(x);

	//头插，前后节点互相链接
	newnode->next = phead->next;
	phead->next->prev = newnode;
	phead->next = newnode;
	newnode->prev = phead;
}

//头插
void LTPopFront(LTNode* phead)
{
	assert(phead);
	assert(!LTEmpty(phead));
	
	//保存第一个节点地址
	LTNode* first = phead->next;
	
	//链接
	phead->next = first->next;
	first->next->prev = phead;

	//释放
	free(first);
	first = NULL;
}

//查找
LTNode* LTFind(LTNode* phead, LTDataType x)
{
	assert(phead);
	LTNode* cur = phead->next;
	while (cur != phead)
	{
		if (cur->data != x)
		{
			cur = cur->next;
		}
		else
		{
			//找到返回要查找数据的地址
			return cur;
		}
	}
	//找不到返回空
	return NULL;
}

//在pos前插入
void LTInsert(LTNode* pos, LTDataType x)
{
	assert(pos);

	LTNode* newnode = BuyLTNode(x);

	//保存pos节点前一个位置
	LTNode* posPrev = pos->prev;

	//链接节点
	newnode->next = pos;
	pos->prev = newnode;
	posPrev->next = newnode;
	newnode->prev = posPrev;
}

//删除pos节点
void LTErase(LTNode* pos)
{
	assert(pos);

	//保存pos节点前后节点位置
	LTNode* posPrev = pos->prev;
	LTNode* posNext = pos->next;

	//链接pos节点的前后节点
	posPrev->next = posNext;
	posNext->prev = posPrev;
	
	//释放，这里不需要对pos置空，因为传的一级指针
	free(pos);
	
}

测试

多进行几组测试来判断接口是否符合预期。
test.c:

#include "dList.h"

void TestDList1()
{
	//这里直接定义的是一个指针，实际它用一个指针就可以指向整个链表，所以这里就定义了一个指针。
	LTNode* plist = LTInit();

	//尾插+打印
	LTPushBack(plist, 1);
	LTPrint(plist);

	//尾插+打印
	LTPushBack(plist, 2);
	LTPrint(plist);

	//尾插+打印
	LTPushBack(plist, 3);
	LTPrint(plist);

	//尾删+打印
	LTPopBack(plist);
	LTPrint(plist);

	//尾删+打印
	LTPopBack(plist);
	LTPrint(plist);
	
	//销毁链表
	LTDestroy(plist);
	
	//使用者对链表结构体指针置空
	plist = NULL;
}

void TestDList2()
{
	//链表初始化
	LTNode* plist = LTInit();
	
	//头插+打印
	LTPushFront(plist, 3);
	LTPrint(plist);
	
	//头插+打印
	LTPushFront(plist, 2);
	LTPrint(plist);
	
	//头插+打印
	LTPushFront(plist, 1);
	LTPrint(plist);
	
	//头删+打印
	LTPopFront(plist);
	LTPrint(plist);

	//在3的前面插入10 + 打印
	LTInsert(LTFind(plist, 3), 10);
	LTPrint(plist);

	//增删查改里的改，先寻找到需要改变数据的的节点，返回该节点地址。然后再进行操作
	LTNode* pos = LTFind(plist, 2);
	//删除pos位置
	LTErase(pos);
	//外部置空
	pos = NULL;
	
	LTPrint(plist);

	//链表的销毁
	LTDestroy(plist);
	plist = NULL;
}

int main()
{
	//TestDList1();
	TestDList2();

	return 0;
}

总结

带头双向循环链表很适合单独进行数据的存储，而且比较容易实现。复杂的结构其实现可能也很简单，需要考虑的方面可能也不会很多。