C++初阶(十二) stack和queue

一、stack的介绍和使用

1.1 stack的介绍

stack的文档介绍

stack是一种容器适配器，专门用在具有后进先出操作的上下文环境中，其删除只能从容器的一端进行元素的插入与提取操作。
stack是作为容器适配器被实现的，容器适配器即是对特定类封装作为其底层的容器，并提供一组特定的成员函数来访问其元素，将特定类作为其底层的，元素特定容器的尾部(即栈顶)被压入和弹出。
stack的底层容器可以是任何标准的容器类模板或者一些其他特定的容器类，这些容器类应该支持以下操作： empty：判空操作 back：获取尾部元素操作 push_back：尾部插入元素操作 pop_back：尾部删除元素操作:
标准容器vector、deque、list均符合这些需求，默认情况下，如果没有为stack指定特定的底层容器，默认情况下使用deque。

什么是适配器

适配器是一种设计模式(设计模式是一套被反复使用的、多数人知晓的、经过分类编目的、代码设计经验的总结)，该种模式是将一个类的接口转换成客户希望的另外一个接口。

1.2 stack的使用

函数说明	接口说明
stack()	构造空的栈
empty()	检测stack是否为空
size()	返回stack中元素的个数
top()	返回栈顶元素的引用
push()	将元素val压入stack中
pop()	将stack中尾部的元素弹出

1.3 stack的模拟实现

从栈的接口中可以看出，栈实际是一种特殊的vector，因此使用vector完全可以模拟实现stack。

#include <vector>

namespace abc {
    template<class T>
    class stack {
    public:
        stack() {}

        // 向栈中添加元素
        void push(const T& x) {
            _c.push_back(x);
        }

        // 移除栈顶元素
        void pop() {
            _c.pop_back();
        }

        // 获取栈顶元素
        T& top() {
            return _c.back();
        }

        // 获取栈顶元素（const版本）
        const T& top() const {
            return _c.back();
        }

        // 获取栈中元素的数量
        size_t size() const {
            return _c.size();
        }

        // 判断栈是否为空
        bool empty() const {
            return _c.empty();
        }

    private:
        std::vector<T> _c; // 使用vector作为底层容器
    };
}

#define _CRT_SECURE_NO_WARNINGS	
#include <iostream>
#include "stack.h" 

int main() {
    abc::stack<int> s;
    s.push(1);
    s.push(2);
    s.push(3);

    std::cout << "栈顶元素为：" << s.top() << std::endl;
    std::cout << "当前栈大小为：" << s.size() << std::endl;

    s.pop();

    std::cout << "栈顶元素为：" << s.top() << std::endl;
    std::cout << "当前栈大小为：" << s.size() << std::endl;

    if (s.empty()) {
        std::cout << "栈为空" << std::endl;
    }
    else {
        std::cout << "栈不为空" << std::endl;
    }

    return 0;
}

二、queue的介绍和使用

2.1 queue的介绍

queue的文档介绍

队列是一种容器适配器，专门用于在FIFO上下文(先进先出)中操作，其中从容器一端插入元素，另一端提取元素。
队列作为容器适配器实现，容器适配器即将特定容器类封装作为其底层容器类，queue提供一组特定的成员函数来访问其元素。元素从队尾入队列，从队头出队列。
底层容器可以是标准容器类模板之一，也可以是其他专门设计的容器类。该底层容器应至少支持以下操作: empty：检测队列是否为空 ,size：返回队列中有效元素的个数, front：返回队头元素的引用, back：返回队尾元素的引用, push_back：在队列尾部入队列 ,pop_front：在队列头部出队列
标准容器类deque和list满足了这些要求。默认情况下，如果没有为queue实例化指定容器类，则使用标准容器deque。

2.2 queue的使用

函数说明	接口说明
queue()	构造空的队列
empty()	检测队列是否为空，是返回true，否则返回false
size()	返回队列中有效元素的个数
front()	返回队头元素的引用
back()	返回队尾元素的引用
push()	在队尾将元素val入队列
pop()	将队头元素出队列

2.3 queue的模拟实现

因为queue的接口中存在头删和尾插，因此使用vector来封装效率太低，故可以借助list来模拟实现queue，具体如下：

#include <list>

namespace abc {
    template<class T>
    class queue {
    public:
        queue() {}

        // 向队列尾部添加元素
        void push(const T& x) {
            _c.push_back(x);
        }

        // 移除队列头部元素
        void pop() {
            _c.pop_front();
        }

        // 获取队列尾部元素
        T& back() {
            return _c.back();
        }

        // 获取队列尾部元素（const版本）
        const T& back() const {
            return _c.back();
        }

        // 获取队列头部元素
        T& front() {
            return _c.front();
        }

        // 获取队列头部元素（const版本）
        const T& front() const {
            return _c.front();
        }

        // 获取队列中元素的数量
        size_t size() const {
            return _c.size();
        }

        // 判断队列是否为空
        bool empty() const {
            return _c.empty();
        }

    private:
        std::list<T> _c; // 使用list作为底层容器
    };
}

#define _CRT_SECURE_NO_WARNINGS	
#include <iostream>
#include "queue.h" // 假设将上述代码保存为queue.h文件

int main() {
    abc::queue<int> q;
    q.push(1);
    q.push(2);
    q.push(3);

    std::cout << "队列头部元素为：" << q.front() << std::endl;
    std::cout << "队列尾部元素为：" << q.back() << std::endl;
    std::cout << "当前队列大小为：" << q.size() << std::endl;

    q.pop();

    std::cout << "队列头部元素为：" << q.front() << std::endl;
    std::cout << "当前队列大小为：" << q.size() << std::endl;

    if (q.empty()) {
        std::cout << "队列为空" << std::endl;
    }
    else {
        std::cout << "队列不为空" << std::endl;
    }

    return 0;
}

三、priority_queue的介绍和使用

3.1 priority_queue的介绍

priority_queue文档介绍

优先队列是一种容器适配器，根据严格的弱排序标准，它的第一个元素总是它所包含的元素中最大的。
此上下文类似于堆，在堆中可以随时插入元素，并且只能检索最大堆元素(优先队列中位于顶部的元素)。
优先队列被实现为容器适配器，容器适配器即将特定容器类封装作为其底层容器类，queue提供一组特定的成员函数来访问其元素。元素从特定容器的“尾部”弹出，其称为优先队列的顶部。
底层容器可以是任何标准容器类模板，也可以是其他特定设计的容器类。容器应该可以通过随机访问迭代器访问，并支持以下操作： empty()：检测容器是否为空 ,size()：返回容器中有效元素个数, front()：返回容器中第一个元素的引用, push_back()：在容器尾部插入元素,pop_back()：删除容器尾部元素
标准容器类vector和deque满足这些需求。默认情况下，如果没有为特定的priority_queue类实例化指定容器类，则使用vector。
需要支持随机访问迭代器，以便始终在内部保持堆结构。容器适配器通过在需要时自动调用算法函数 make_heap、push_heap和pop_heap来自动完成此操作。

make_heap

make_heap是一个用于将一段随机访问迭代器范围内的元素重新排列成堆的算法。调用make_heap之后，范围内的第一个元素将是最大元素（在最大堆中）或最小元素（在最小堆中）。
push_heap

在向堆中添加新元素后，push_heap算法可以用来重新调整堆，以确保新增加的元素被放置在正确的位置，从而维持堆的性质。通常，这意味着将新元素添加到底层容器的末尾，然后使用push_heap进行调整。
pop_heap

pop_heap算法用于移除堆顶元素。通常，这涉及到将堆顶元素与底层容器中的最后一个元素交换，然后从堆中移除最后一个元素（现在是原来的堆顶元素），最后调用pop_heap来重新调整剩余元素，维持堆的性质。

3.2 priority_queue的使用

先级队列默认使用vector作为其底层存储数据的容器，在vector上又使用了堆算法将vector中元素构造成堆的结构，因此priority_queue就是堆，所有需要用到堆的位置，都可以考虑使用priority_queue。注意：默认情况下priority_queue是大堆。

函数说明	接口说明
priority_queue()/priority_queue(first, last)	构造一个空的优先级队列
empty()	检测优先级队列是否为空，是返回true，否则返回 false
top( )	返回优先级队列中最大(最小元素)，即堆顶元素
push(x)	在优先级队列中插入元素x
pop()	删除优先级队列中最大(最小)元素，即堆顶元素

【注意】 1. 默认情况下，priority_queue是大堆。

#include <iostream>
#include <vector>
#include <queue>
#include <functional>

using namespace std;

// 定义一个测试优先队列的函数
void TestPriorityQueue() {
    // 创建一个包含10个整数的vector
    vector<int> v{ 3, 2, 7, 6, 0, 4, 1, 9, 8, 5 };

    // 默认情况下，创建的是大堆，其底层按照小于号比较
    priority_queue<int> q1;
    for (auto& e : v)
        q1.push(e);
    
    // 输出大根堆的堆顶元素
    cout << q1.top() << endl;

    // 创建一个小根堆,将第三个模板参数换成greater比较方式
    priority_queue<int, vector<int>, greater<int>> q2(v.begin(), v.end());
    
    // 输出小根堆的堆顶元素
    cout << q2.top() << endl;
}

int main() {
   
    TestPriorityQueue();
    return 0;
}

包含`<functional>`头文件是为了使用函数对象和函数模板，可以方便地进行各种操作，包括优先队列的自定义比较方式。

2. 如果在priority_queue中放自定义类型的数据，用户需要在自定义类型中提供> 或者< 的重载。

#include <iostream>
#include <vector>
#include <queue>
#include <functional>

using namespace std;

// 定义日期类
class Date {
public:
    Date(int year = 1900, int month = 1, int day = 1)
        : _year(year)
        , _month(month)
        , _day(day)
    {}

    // 重载小于运算符
    bool operator<(const Date& d) const {
        return (_year < d._year) ||
            (_year == d._year && _month < d._month) ||
            (_year == d._year && _month == d._month && _day < d._day);
    }

    // 重载大于运算符
    bool operator>(const Date& d) const {
        return (_year > d._year) ||
            (_year == d._year && _month > d._month) ||
            (_year == d._year && _month == d._month && _day > d._day);
    }

    // 友元函数，重载输出运算符
    friend ostream& operator<<(ostream& _cout, const Date& d) {
        _cout << d._year << "-" << d._month << "-" << d._day;
        return _cout;
    }

private:
    int _year;   // 年
    int _month;  // 月
    int _day;    // 日
};

// 测试优先队列的函数
void TestPriorityQueue() {
    // 创建一个大根堆，使用默认的比较方式（小于）
    priority_queue<Date> q1;
    q1.push(Date(2024, 10, 29));
    q1.push(Date(2024, 10, 28));
    q1.push(Date(2024, 10, 30));
    cout << q1.top() << endl;

    // 创建一个小根堆，使用greater比较方式（大于）
    priority_queue<Date, vector<Date>, greater<Date>> q2;
    q2.push(Date(2024, 10, 29));
    q2.push(Date(2024, 10, 28));
    q2.push(Date(2024, 10, 30));
    cout << q2.top() << endl;
}

int main() {
    TestPriorityQueue();
    return 0;
}

3.3 priority_queue的模拟实现

通过对priority_queue的底层结构就是堆，因此此处只需对对进行通用的封装即可。

#pragma once

#include <iostream>
using namespace std;

#include <vector>
// priority_queue--->堆
namespace abc
{
	// 比较器，大顶堆
	template<class T>
	struct less
	{
		bool operator()(const T& left, const T& right)
		{
			return left < right;
		}
	};

	// 比较器，小顶堆
	template<class T>
	struct greater
	{
		bool operator()(const T& left, const T& right)
		{
			return left > right;
		}
	};

	// 优先级队列模板类
	/* T 是优先级队列中存储的元素类型，
	Container 是用于存储元素的容器类型，默认为 std::vector<T>，
	Compare 是用于比较元素大小的函数对象，默认为 less<T>
	*/
	template<class T, class Container = std::vector<T>, class Compare = less<T>>
	class priority_queue
	{
	public:
		// 创建一个空的优先级队列
		priority_queue() : c() {}

		// 使用迭代器范围构造优先级队列
		template<class Iterator>
		priority_queue(Iterator first, Iterator last)
			: c(first, last)
		{
			// 将c中的元素调整成堆的结构
			int count = c.size();
			int root = ((count - 2) >> 1);
			for (; root >= 0; root--)
				AdjustDown(root);
		}

		// 插入元素
		void push(const T& data)
		{
			c.push_back(data);
			AdjustUP(c.size() - 1);
		}

		// 弹出堆顶元素
		void pop()
		{
			if (empty())
				return;

			swap(c.front(), c.back());
			c.pop_back();
			AdjustDown(0);
		}

		// 返回队列大小
		size_t size() const
		{
			return c.size();
		}

		// 判断队列是否为空
		bool empty() const
		{
			return c.empty();
		}

		// 返回堆顶元素（只读）
		const T& top() const
		{
			return c.front();
		}

	private:
		// 向上调整
		void AdjustUP(int child)
		{
			int parent = ((child - 1) >> 1);
			while (child)
			{
				// 如果子节点的值比父节点的值大（根据Compare函数确定）
				if (Compare()(c[parent], c[child]))
				{
					swap(c[child], c[parent]);
					child = parent;
					parent = ((child - 1) >> 1);
				}
				else
				{
					return;
				}
			}
		}

		// 向下调整
		void AdjustDown(int parent)
		{
			size_t child = parent * 2 + 1;
			while (child < c.size())
			{
				// 找以parent为根的较大的孩子
				/*如果右孩子存在，并且右孩子比左孩子大，
				则将child更新为右孩子的索引
				*/
				if (child + 1 < c.size() && Compare()(c[child], c[child + 1]))
					child += 1;

				// 比较父节点和较大孩子节点的值，检测双亲是否满足情况
				if (Compare()(c[parent], c[child]))
				{
					swap(c[child], c[parent]);
					parent = child;
					child = parent * 2 + 1;
				}
				else
					return;
			}
		}

	private:
		Container c;
	};
}

// 测试优先级队列功能
void TestQueuePriority()
{
	abc::priority_queue<int> q1;
	q1.push(5);
	q1.push(1);
	q1.push(4);
	q1.push(2);
	q1.push(3);
	q1.push(6);
	cout << q1.top() << endl;
	cout << "----------------" << endl;
	q1.pop();
	q1.pop();
	cout << q1.top() << endl;
	cout << "----------------" << endl;
	vector<int> v{ 5,1,4,2,3,6 };
	abc::priority_queue<int, vector<int>, abc::greater<int>> q2(v.begin(), v.end());
	cout << q2.top() << endl;
	cout << "----------------" << endl;
	q2.pop();
	q2.pop();
	cout << q2.top() << endl;
}

#define _CRT_SECURE_NO_WARNINGS	
#include <iostream>
#include "priority_queue.h" 

int main() {
    TestQueuePriority();
    return 0;
}

四、deque的简单介绍(了解)

STL标准库中stack和queue的底层结构虽然stack和queue中也可以存放元素，但在STL中并没有将其划分在容器的行列，而是将其称为容器适配器，这是因为stack和队列只是对其他容器的接口进行了包装，STL中stack和queue默认使用deque，比如：

4.1 deque的原理介绍

deque(双端队列)：是一种双开口的"连续"空间的数据结构，双开口的含义是：可以在头尾两端进行插入和删除操作，且时间复杂度为O(1)，与vector比较，头插效率高，不需要搬移元素；与list比较，空间利用率比较高。

deque并不是真正连续的空间，而是由一段段连续的小空间拼接而成的，实际deque类似于一个动态的二维数组，其底层结构如下图所示：

双端队列底层是一段假象的连续空间，实际是分段连续的，为了维护其“整体连续”以及随机访问的假象，落在了deque的迭代器身上，因此deque的迭代器设计就比较复杂，如下图所示：

那deque是如何借助其迭代器维护其假想连续的结构呢？

具体而言，deque的底层结构通常是由一个中央控制器（central controller）和多个缓冲区（buffer）组成的。

中央控制器维护了一个指向第一个缓冲区和最后一个缓冲区的指针，以及当前deque中元素的数量等信息。

每个缓冲区都是一个定长的数组，其大小通常为2的整数次幂，这样可以使得访问缓冲区中的元素时效率更高。缓冲区之间通过指针连接，形成一个双向链表。

当用户对deque进行插入或删除操作时，deque会根据需要在中央控制器指向的两端的缓冲区中进行元素的插入和删除操作，同时可能会在其中一个端点（例如头部）不足时申请新的缓冲区，并将其插入到deque的头部或尾部，以保持deque的连续性和数据结构的平衡性。

需要注意的是，由于deque的底层结构是由多个缓冲区组成的，因此访问deque的元素时需要进行两层索引，首先通过中央控制器的指针找到对应的缓冲区，然后再在缓冲区中进行元素的访问。

4.2 deque的缺陷

与vector比较，deque的优势是：头部插入和删除时，不需要搬移元素，效率特别高，而且在扩容时，也不需要搬移大量的元素，因此其效率是必vector高的。与list比较，其底层是连续空间，空间利用率比较高，不需要存储额外字段。但是，deque有一个致命缺陷：不适合遍历，因为在遍历时，deque的迭代器要频繁的去检测其是否移动到某段小空间的边界，导致效率低下，而序列式场景中，可能需要经常遍历，因此在实际中，需要线性结构时，大多数情况下优先考虑vector和list，deque的应用并不多，而目前能看到的一个应用就是，STL用其作为stack和queue的底层数据结构。

4.3 为什么选择deque作为stack和queue的底层默认容器

stack是一种后进先出的特殊线性数据结构，因此只要具有push_back()和pop_back()操作的线性结构，都可以作为stack的底层容器，比如vector和list都可以；queue是先进先出的特殊线性数据结构，只要具有 push_back和pop_front操作的线性结构，都可以作为queue的底层容器，比如list。但是STL中对stack和 queue默认选择deque作为其底层容器，主要是因为：

1. stack和queue不需要遍历(因此stack和queue没有迭代器)，只需要在固定的一端或者两端进行操作。

2. 在stack中元素增长时，deque比vector的效率高(扩容时不需要搬移大量数据)；queue中的元素增长时，deque不仅效率高，而且内存使用率高。结合了deque的优点，而完美的避开了其缺陷。

4.4 使用deque对stack和queue模拟实现

stack的模拟实现

#pragma once
#include <deque>

namespace bite {
    template<class T, class Con = std::deque<T>>
    // 如果需要使用其他容器作为底层容器，可以修改这里的模板参数，比如vector或list
    // template<class T, class Con = std::vector<T>>
    // template<class T, class Con = std::list<T>>
    class stack {
    public:
        stack() {}  // 默认构造函数

        void push(const T& x) {
            _c.push_back(x);  // 将元素压入栈，调用底层容器的push_back方法
        }

        void pop() {
            _c.pop_back();  // 弹出栈顶元素，调用底层容器的pop_back方法
        }

        T& top() {
            return _c.back();  // 返回栈顶元素的引用，调用底层容器的back方法
        }

        const T& top() const {
            return _c.back();  // 返回栈顶元素的常量引用，调用底层容器的back方法
        }

        size_t size() const {
            return _c.size();  // 返回栈中元素的数量，调用底层容器的size方法
        }

        bool empty() const {
            return _c.empty();  // 判断栈是否为空，调用底层容器的empty方法
        }

    private:
        Con _c;  // 使用底层容器保存栈的元素
    };
}

#define _CRT_SECURE_NO_WARNINGS	
#include <iostream>
#include "mystack.h"  

int main() {
    bite::stack<int> intStack;  // 使用int类型和默认底层容器std::deque实例化栈对象

    intStack.push(1);  // 压入元素1
    intStack.push(2);  // 压入元素2
    intStack.push(3);  // 压入元素3

    std::cout << "Size of stack: " << intStack.size() << std::endl;  // 输出栈的大小

    while (!intStack.empty()) {
        std::cout << "Top element: " << intStack.top() << std::endl;  // 输出栈顶元素
        intStack.pop();  // 弹出栈顶元素
    }

    return 0;
}

queue的模拟实现

#pragma once
#include <deque>
#include <list>

namespace bite {
    template<class T, class Con = std::deque<T>>
    // 如果需要使用其他容器作为底层容器，可以修改这里的模板参数，比如std::list
    // template<class T, class Con = std::list<T>>
    class queue {
    public:
        queue() {}  // 默认构造函数

        void push(const T& x) {
            _c.push_back(x);  // 将元素推入队列，调用底层容器的push_back方法
        }

        void pop() {
            _c.pop_front();  // 弹出队首元素，调用底层容器的pop_front方法
        }

        T& back() {
            return _c.back();  // 返回队尾元素的引用，调用底层容器的back方法
        }

        const T& back() const {
            return _c.back();  // 返回队尾元素的常量引用，调用底层容器的back方法
        }

        T& front() {
            return _c.front();  // 返回队首元素的引用，调用底层容器的front方法
        }

        const T& front() const {
            return _c.front();  // 返回队首元素的常量引用，调用底层容器的front方法
        }

        size_t size() const {
            return _c.size();  // 返回队列中元素的数量，调用底层容器的size方法
        }

        bool empty() const {
            return _c.empty();  // 判断队列是否为空，调用底层容器的empty方法
        }

    private:
        Con _c;  // 使用底层容器保存队列的元素
    };
}

#define _CRT_SECURE_NO_WARNINGS	
#include <iostream>
#include "myqueue.h"  

using namespace std;
using namespace bite;

int main() {
    queue<int> q;  // 创建一个int类型的队列

    // 将10个整数依次推入队列
    for (int i = 1; i <= 10; ++i) {
        q.push(i);
    }

    // 打印队列中的元素
    while (!q.empty()) {
        cout << q.front() << " ";  // 输出队首元素
        q.pop();  // 弹出队首元素
    }
    cout << endl;

    return 0;
}