提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档
栈
前言
本次来实现一个数据结构——栈。
一、栈是什么?
栈是一种特殊的线性表,其只允许在固定的一端进行插入和删除元素操作。进行数据插入和删除操作的一端称为栈顶,另一端称为栈底。栈中的数据元素遵守后进先出LIFO(Last In First Out)的原则。
入栈:从栈顶插入数据。
出栈:将栈顶的元素删除。
图例:
二、具体实现
1.定义
//便于后续栈数据类型的修改
typedef int STDataType;
typedef struct Stack
{
STDataType* data; //本体
int top; // 栈顶
int capacity; // 容量
}Stack;
这里选择用数组来实现栈,其中STDataType是栈中的元素类型,typedef重命名便于后续需要变更栈存储的元素类型,这里采用动态的方法来开辟空间,这样也便于栈满时的扩容,相对于静态存储更灵活些,,top这里表示为栈顶元素的上一个,也表示当前栈中共有几个元素,capacity表示栈当前的总容量。
2.初始化
// 初始化栈
void StackInit(Stack* ps)
{
assert(ps);
STDataType* tmp = (STDataType*)malloc(sizeof(STDataType) * 5);
if (!tmp)
{
perror("malloc()");
exit(-1);
}
ps->data = tmp;
ps->capacity = 5;
ps->top = 0; //top指向栈顶的上一个
}
assert断言以防调用者对于Stack结构体的错误初始化,这里初始化默认malloc开辟一块只有5个STDataType类型元素的空间,if语句判断malloc开辟是否成功(一般都不会开辟失败的,除非内存已经所剩空间不多,或者一次所需开辟的空间大小太大才会导致开辟失败),最后把开辟成功的空间交由data接管,并把当前总容量(capacity)置为5,top置为0。
3.入栈
// 入栈
void StackPush(Stack* ps, STDataType data)
{
//空间满了,扩容
if (ps->top == ps->capacity)
{
STDataType* tmp = (STDataType*)realloc(ps->data, sizeof(STDataType) * ps->capacity + 5);
if (!tmp)
{
perror("realloc()");
exit(-1);
}
ps->data = tmp;
ps->capacity += 5;
}
//空间没满,正常入栈
ps->data[ps->top++] = data;
}
入栈前首先要判断栈是否已经满了,如果top等于capacity相等就表示当前栈已满,就要进行扩容,用realloc进行扩容,realloc有两个参数,第一个是要对哪片动态开辟的空间进行扩容,也就是扩容的对象;第二个是扩容后的空间大小。注意:realloc的第二个参数不是你想要当前空间再增加多大,而是当前空间加上增加后的空间一共是多大,比如当前空间是5byte,你要扩容到10byte,那么此时第二个参数就不能只写5byte,而要写10byte,当然栈进行了扩容,那么capacity也要进行相应的修改,最后再进行正常的入栈,把栈中下标为top的位置赋值为data,然后top++。
图示:
1)栈未满
2)栈满
4.出栈
// 出栈
void StackPop(Stack* ps)
{
assert(ps);
assert(ps->top);
ps->top--;
}
出栈操作十分简单,把栈顶的元素删除即可,而因为底层采用的是数组,top即表示栈顶元素的下一个,也表示栈中的实际元素的个数,所以只需top–即可完成出栈操作,需要注意的是当top为0时,也就表示当前栈中没有数据,没有数据也就不能进行出栈操作,所以assert断言一下当top为0时的情况!
图示:
5.获取栈顶元素
// 获取栈顶元素
STDataType StackTop(Stack* ps)
{
assert(ps);
assert(ps->top);
return ps->data[ps->top - 1];
}
获取栈顶元素也十分简单,因为top是栈顶的下一个元素的下标,所以top-1就是栈顶的元素的下标,直接返回data[top-1]即可!需要注意的是当top为0时,也就表示当前栈中没有数据,没有数据也就不能进行取顶操作,所以assert断言一下当top为0时的情况!
6.获取栈中有效元素个数
// 获取栈中有效元素个数
int StackSize(Stack* ps)
{
assert(ps);
return ps->top;
}
获取栈中的有效元素的个数也十分简单,我们都知道数组的下标是从0开始的,而top正好是当前元素的下标的下一个,所以栈中的实际个数就是top的值,直接返回top即可!
7.判断栈是否为空
// 检测栈是否为空
bool StackEmpty(Stack* ps)
{
assert(ps);
return ps->top == 0;
}
判空操作也十分简单,既然top代表栈中实际存储的个数,那么top == 0(为真)时,就为空,top != 0(为假)时就不为空,这里返回类型也可以用int,那么返回值1(真)就表示为空,0(假)就表示不为空,当然返回值用bool(布尔)也是没有问题的,但是在C语言中用bool这个类型,需要引用头文件 #include<stdbool.h>
8.销毁栈
// 销毁栈
void StackDestroy(Stack* ps)
{
assert(ps);
free(ps->data);
ps->data = NULL;
ps->capacity = ps->top = 0;
}
栈的销毁操作也不复杂,该释放的释放就好了,这里只有data这个数组是malloc开辟的,所以只需free(释放)其即可,为避免野指针,再把其置为NULL,最后把capacity和top都置为0即可。
三、完整代码
1.test.c
#include"newstack.h"
void Test1()
{
Stack stack;
StackInit(&stack);
StackPush(&stack, 5);
StackPush(&stack, 4);
StackPush(&stack, 3);
StackPush(&stack, 2);
StackPush(&stack, 1);
StackPush(&stack, 0);
int len = StackSize(&stack);
for (int i = 0; i < len; i++)
{
printf("%d ", StackTop(&stack));
StackPop(&stack);
}
printf("\n");
}
void Test2()
{
Stack stack;
StackInit(&stack);
//StackPop(&stack);
//StackTop(&stack);
StackPush(&stack, 5);
StackPush(&stack, 4);
StackPush(&stack, 3);
StackPush(&stack, 2);
StackPush(&stack, 1);
StackPush(&stack, 0);
printf("%d\n", StackSize(&stack));
if (StackEmpty(&stack))
{
printf("栈为空\n");
}
else
{
printf("栈不为空\n");
}
}
void Test3()
{
Stack stack;
StackInit(&stack);
StackPush(&stack, 5);
StackPush(&stack, 4);
StackPush(&stack, 3);
StackPush(&stack, 2);
StackPush(&stack, 1);
StackPush(&stack, 0);
printf("%d\n", StackSize(&stack));
StackDestroy(&stack);
printf("%d\n", StackSize(&stack));
}
int main()
{
//Test1();
//Test2();
Test3();
return 0;
}
2.stack.h
#pragma once
#include<stdio.h>
#include<assert.h>
#include<stdlib.h>
#include<stdbool.h>
// 支持动态增长的栈
//便于后续栈数据类型的修改
typedef int STDataType;
typedef struct Stack
{
STDataType* data; //本体
int top; // 栈顶
int capacity; // 容量
}Stack;
// 初始化栈
void StackInit(Stack* ps);
// 入栈
void StackPush(Stack* ps, STDataType data);
// 出栈
void StackPop(Stack* ps);
// 获取栈顶元素
STDataType StackTop(Stack* ps);
// 获取栈中有效元素个数
int StackSize(Stack* ps);
// 检测栈是否为空
bool StackEmpty(Stack* ps);
// 销毁栈
void StackDestroy(Stack* ps);
3.stack.c
#include"newstack.h"
// 初始化栈
void StackInit(Stack* ps)
{
assert(ps);
STDataType* tmp = (STDataType*)malloc(sizeof(STDataType) * 5);
if (!tmp)
{
perror("malloc()");
exit(-1);
}
ps->data = tmp;
ps->capacity = 5;
ps->top = 0; //top指向栈顶的上一个
}
// 入栈
void StackPush(Stack* ps, STDataType data)
{
//空间满了,扩容
if (ps->top == ps->capacity)
{
STDataType* tmp = (STDataType*)realloc(ps->data, sizeof(STDataType) * ps->capacity + 5);
if (!tmp)
{
perror("realloc()");
exit(-1);
}
ps->data = tmp;
ps->capacity += 5;
}
//空间没满,正常入栈
ps->data[ps->top++] = data;
}
// 出栈
void StackPop(Stack* ps)
{
assert(ps);
assert(ps->top);
ps->top--;
}
// 获取栈顶元素
STDataType StackTop(Stack* ps)
{
assert(ps);
assert(ps->top);
return ps->data[ps->top - 1];
}
// 获取栈中有效元素个数
int StackSize(Stack* ps)
{
assert(ps);
return ps->top;
}
// 检测栈是否为空
bool StackEmpty(Stack* ps)
{
assert(ps);
return ps->top == 0;
}
// 销毁栈
void StackDestroy(Stack* ps)
{
assert(ps);
free(ps->data);
ps->data = NULL;
ps->capacity = ps->top = 0;
}
总结
至此栈的实现就完成了。