blob: 6dd055e86860f1e498d93382f41f10221e20a7a7 [file] [log] [blame]
Howard Hinnantc51e1022010-05-11 19:42:16 +00001// -*- C++ -*-
2//===---------------------------- stack -----------------------------------===//
3//
Chandler Carruthd2012102019-01-19 10:56:40 +00004// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Howard Hinnantc51e1022010-05-11 19:42:16 +00007//
8//===----------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_STACK
11#define _LIBCPP_STACK
12
13/*
14 stack synopsis
15
16namespace std
17{
18
19template <class T, class Container = deque<T>>
20class stack
21{
22public:
23 typedef Container container_type;
24 typedef typename container_type::value_type value_type;
25 typedef typename container_type::reference reference;
26 typedef typename container_type::const_reference const_reference;
27 typedef typename container_type::size_type size_type;
28
29protected:
30 container_type c;
31
32public:
Howard Hinnante0da4a12011-06-04 22:09:19 +000033 stack() = default;
34 ~stack() = default;
35
36 stack(const stack& q) = default;
37 stack(stack&& q) = default;
38
39 stack& operator=(const stack& q) = default;
40 stack& operator=(stack&& q) = default;
41
Howard Hinnantc51e1022010-05-11 19:42:16 +000042 explicit stack(const container_type& c);
43 explicit stack(container_type&& c);
Howard Hinnantc51e1022010-05-11 19:42:16 +000044 template <class Alloc> explicit stack(const Alloc& a);
45 template <class Alloc> stack(const container_type& c, const Alloc& a);
46 template <class Alloc> stack(container_type&& c, const Alloc& a);
Howard Hinnante0da4a12011-06-04 22:09:19 +000047 template <class Alloc> stack(const stack& c, const Alloc& a);
Howard Hinnantc51e1022010-05-11 19:42:16 +000048 template <class Alloc> stack(stack&& c, const Alloc& a);
49
50 bool empty() const;
51 size_type size() const;
52 reference top();
53 const_reference top() const;
54
55 void push(const value_type& x);
56 void push(value_type&& x);
Marshall Clowea52cc42017-01-24 23:09:12 +000057 template <class... Args> reference emplace(Args&&... args); // reference in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +000058 void pop();
59
Eric Fiselier6bfed252016-04-21 23:38:59 +000060 void swap(stack& c) noexcept(is_nothrow_swappable_v<Container>)
Howard Hinnantc51e1022010-05-11 19:42:16 +000061};
62
Marshall Clow592d9952018-05-22 01:57:53 +000063template<class Container>
64 stack(Container) -> stack<typename Container::value_type, Container>; // C++17
Louis Dionne173f29e2019-05-29 16:01:36 +000065
66template<class Container, class Allocator>
Marshall Clow592d9952018-05-22 01:57:53 +000067 stack(Container, Allocator) -> stack<typename Container::value_type, Container>; // C++17
68
Howard Hinnantc51e1022010-05-11 19:42:16 +000069template <class T, class Container>
70 bool operator==(const stack<T, Container>& x, const stack<T, Container>& y);
71template <class T, class Container>
72 bool operator< (const stack<T, Container>& x, const stack<T, Container>& y);
73template <class T, class Container>
74 bool operator!=(const stack<T, Container>& x, const stack<T, Container>& y);
75template <class T, class Container>
76 bool operator> (const stack<T, Container>& x, const stack<T, Container>& y);
77template <class T, class Container>
78 bool operator>=(const stack<T, Container>& x, const stack<T, Container>& y);
79template <class T, class Container>
80 bool operator<=(const stack<T, Container>& x, const stack<T, Container>& y);
81
82template <class T, class Container>
Howard Hinnante0da4a12011-06-04 22:09:19 +000083 void swap(stack<T, Container>& x, stack<T, Container>& y)
84 noexcept(noexcept(x.swap(y)));
Howard Hinnantc51e1022010-05-11 19:42:16 +000085
86} // std
87
88*/
89
90#include <__config>
Christopher Di Bella41f26e82021-06-05 02:47:47 +000091#include <__utility/forward.h>
Howard Hinnantc51e1022010-05-11 19:42:16 +000092#include <deque>
93
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000094#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Howard Hinnantc51e1022010-05-11 19:42:16 +000095#pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000096#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +000097
98_LIBCPP_BEGIN_NAMESPACE_STD
99
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000100template <class _Tp, class _Container = deque<_Tp> > class _LIBCPP_TEMPLATE_VIS stack;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000101
102template <class _Tp, class _Container>
Howard Hinnanta54386e2012-09-14 00:39:16 +0000103_LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000104bool
105operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
106
107template <class _Tp, class _Container>
Howard Hinnanta54386e2012-09-14 00:39:16 +0000108_LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000109bool
110operator< (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
111
Marshall Clow9e1b8452015-02-18 17:51:56 +0000112template <class _Tp, class _Container /*= deque<_Tp>*/>
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000113class _LIBCPP_TEMPLATE_VIS stack
Howard Hinnantc51e1022010-05-11 19:42:16 +0000114{
115public:
116 typedef _Container container_type;
117 typedef typename container_type::value_type value_type;
118 typedef typename container_type::reference reference;
119 typedef typename container_type::const_reference const_reference;
120 typedef typename container_type::size_type size_type;
Marshall Clowb8825f02016-03-14 17:58:11 +0000121 static_assert((is_same<_Tp, value_type>::value), "" );
Louis Dionne173f29e2019-05-29 16:01:36 +0000122
Howard Hinnantc51e1022010-05-11 19:42:16 +0000123protected:
124 container_type c;
125
126public:
Howard Hinnant186dca82010-09-23 17:31:07 +0000127 _LIBCPP_INLINE_VISIBILITY
Howard Hinnante0da4a12011-06-04 22:09:19 +0000128 stack()
129 _NOEXCEPT_(is_nothrow_default_constructible<container_type>::value)
130 : c() {}
131
132 _LIBCPP_INLINE_VISIBILITY
133 stack(const stack& __q) : c(__q.c) {}
134
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000135 _LIBCPP_INLINE_VISIBILITY
136 stack& operator=(const stack& __q) {c = __q.c; return *this;}
137
138
139#ifndef _LIBCPP_CXX03_LANG
Howard Hinnante0da4a12011-06-04 22:09:19 +0000140 _LIBCPP_INLINE_VISIBILITY
141 stack(stack&& __q)
142 _NOEXCEPT_(is_nothrow_move_constructible<container_type>::value)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000143 : c(_VSTD::move(__q.c)) {}
Howard Hinnante0da4a12011-06-04 22:09:19 +0000144
145 _LIBCPP_INLINE_VISIBILITY
Howard Hinnante0da4a12011-06-04 22:09:19 +0000146 stack& operator=(stack&& __q)
147 _NOEXCEPT_(is_nothrow_move_assignable<container_type>::value)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000148 {c = _VSTD::move(__q.c); return *this;}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000149
150 _LIBCPP_INLINE_VISIBILITY
151 explicit stack(container_type&& __c) : c(_VSTD::move(__c)) {}
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400152#endif // _LIBCPP_CXX03_LANG
Howard Hinnante0da4a12011-06-04 22:09:19 +0000153
Howard Hinnant186dca82010-09-23 17:31:07 +0000154 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000155 explicit stack(const container_type& __c) : c(__c) {}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000156
Howard Hinnantc51e1022010-05-11 19:42:16 +0000157 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000158 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000159 explicit stack(const _Alloc& __a,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500160 _EnableIf<uses_allocator<container_type, _Alloc>::value>* = 0)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000161 : c(__a) {}
162 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000163 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000164 stack(const container_type& __c, const _Alloc& __a,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500165 _EnableIf<uses_allocator<container_type, _Alloc>::value>* = 0)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000166 : c(__c, __a) {}
167 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000168 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000169 stack(const stack& __s, const _Alloc& __a,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500170 _EnableIf<uses_allocator<container_type, _Alloc>::value>* = 0)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000171 : c(__s.c, __a) {}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000172#ifndef _LIBCPP_CXX03_LANG
Howard Hinnantc51e1022010-05-11 19:42:16 +0000173 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000174 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000175 stack(container_type&& __c, const _Alloc& __a,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500176 _EnableIf<uses_allocator<container_type, _Alloc>::value>* = 0)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000177 : c(_VSTD::move(__c), __a) {}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000178 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000179 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000180 stack(stack&& __s, const _Alloc& __a,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500181 _EnableIf<uses_allocator<container_type, _Alloc>::value>* = 0)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000182 : c(_VSTD::move(__s.c), __a) {}
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400183#endif // _LIBCPP_CXX03_LANG
Howard Hinnantc51e1022010-05-11 19:42:16 +0000184
Marshall Clow425f5752017-11-15 05:51:26 +0000185 _LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000186 bool empty() const {return c.empty();}
Howard Hinnant186dca82010-09-23 17:31:07 +0000187 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000188 size_type size() const {return c.size();}
Howard Hinnant186dca82010-09-23 17:31:07 +0000189 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000190 reference top() {return c.back();}
Howard Hinnant186dca82010-09-23 17:31:07 +0000191 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000192 const_reference top() const {return c.back();}
193
Howard Hinnant186dca82010-09-23 17:31:07 +0000194 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000195 void push(const value_type& __v) {c.push_back(__v);}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000196#ifndef _LIBCPP_CXX03_LANG
Howard Hinnant186dca82010-09-23 17:31:07 +0000197 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000198 void push(value_type&& __v) {c.push_back(_VSTD::move(__v));}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000199
Howard Hinnant186dca82010-09-23 17:31:07 +0000200 template <class... _Args>
201 _LIBCPP_INLINE_VISIBILITY
Marshall Clowea52cc42017-01-24 23:09:12 +0000202#if _LIBCPP_STD_VER > 14
Marshall Clow88746852018-01-24 22:42:25 +0000203 decltype(auto) emplace(_Args&&... __args)
Eric Fiselier34ba5b92016-07-21 03:20:17 +0000204 { return c.emplace_back(_VSTD::forward<_Args>(__args)...);}
Marshall Clowea52cc42017-01-24 23:09:12 +0000205#else
206 void emplace(_Args&&... __args)
207 { c.emplace_back(_VSTD::forward<_Args>(__args)...);}
208#endif
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400209#endif // _LIBCPP_CXX03_LANG
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000210
Howard Hinnant186dca82010-09-23 17:31:07 +0000211 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000212 void pop() {c.pop_back();}
213
Howard Hinnant186dca82010-09-23 17:31:07 +0000214 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000215 void swap(stack& __s)
Howard Hinnante0da4a12011-06-04 22:09:19 +0000216 _NOEXCEPT_(__is_nothrow_swappable<container_type>::value)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000217 {
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000218 using _VSTD::swap;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000219 swap(c, __s.c);
220 }
221
222 template <class T1, class _C1>
223 friend
224 bool
225 operator==(const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
Howard Hinnant3b6579a2010-08-22 00:02:43 +0000226
Howard Hinnantc51e1022010-05-11 19:42:16 +0000227 template <class T1, class _C1>
228 friend
229 bool
230 operator< (const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
231};
232
Marshall Clow592d9952018-05-22 01:57:53 +0000233#ifndef _LIBCPP_HAS_NO_DEDUCTION_GUIDES
234template<class _Container,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500235 class = _EnableIf<!__is_allocator<_Container>::value>
Marshall Clow592d9952018-05-22 01:57:53 +0000236>
237stack(_Container)
238 -> stack<typename _Container::value_type, _Container>;
Louis Dionne173f29e2019-05-29 16:01:36 +0000239
Marshall Clow592d9952018-05-22 01:57:53 +0000240template<class _Container,
241 class _Alloc,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500242 class = _EnableIf<!__is_allocator<_Container>::value>,
Arthur O'Dwyer9b9662f2021-03-01 17:08:24 -0500243 class = _EnableIf<uses_allocator<_Container, _Alloc>::value>
Louis Dionne173f29e2019-05-29 16:01:36 +0000244 >
Marshall Clow592d9952018-05-22 01:57:53 +0000245stack(_Container, _Alloc)
246 -> stack<typename _Container::value_type, _Container>;
247#endif
248
Howard Hinnantc51e1022010-05-11 19:42:16 +0000249template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000250inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000251bool
252operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
253{
254 return __x.c == __y.c;
255}
256
257template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000258inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000259bool
260operator< (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
261{
262 return __x.c < __y.c;
263}
264
265template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000266inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000267bool
268operator!=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
269{
270 return !(__x == __y);
271}
272
273template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000274inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000275bool
276operator> (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
277{
278 return __y < __x;
279}
280
281template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000282inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000283bool
284operator>=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
285{
286 return !(__x < __y);
287}
288
289template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000290inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000291bool
292operator<=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
293{
294 return !(__y < __x);
295}
296
297template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000298inline _LIBCPP_INLINE_VISIBILITY
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500299_EnableIf<__is_swappable<_Container>::value, void>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000300swap(stack<_Tp, _Container>& __x, stack<_Tp, _Container>& __y)
Howard Hinnante0da4a12011-06-04 22:09:19 +0000301 _NOEXCEPT_(_NOEXCEPT_(__x.swap(__y)))
Howard Hinnantc51e1022010-05-11 19:42:16 +0000302{
303 __x.swap(__y);
304}
305
306template <class _Tp, class _Container, class _Alloc>
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000307struct _LIBCPP_TEMPLATE_VIS uses_allocator<stack<_Tp, _Container>, _Alloc>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000308 : public uses_allocator<_Container, _Alloc>
309{
310};
311
312_LIBCPP_END_NAMESPACE_STD
313
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400314#endif // _LIBCPP_STACK