blob: 79cc15d964544d1e8b9c486c2f1d75145581c193 [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 Bella55d7a822021-07-01 09:25:35 -040091#include <__memory/uses_allocator.h>
Christopher Di Bella41f26e82021-06-05 02:47:47 +000092#include <__utility/forward.h>
Howard Hinnantc51e1022010-05-11 19:42:16 +000093#include <deque>
94
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000095#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Howard Hinnantc51e1022010-05-11 19:42:16 +000096#pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000097#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +000098
99_LIBCPP_BEGIN_NAMESPACE_STD
100
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000101template <class _Tp, class _Container = deque<_Tp> > class _LIBCPP_TEMPLATE_VIS stack;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000102
103template <class _Tp, class _Container>
Howard Hinnanta54386e2012-09-14 00:39:16 +0000104_LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000105bool
106operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
107
108template <class _Tp, class _Container>
Howard Hinnanta54386e2012-09-14 00:39:16 +0000109_LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000110bool
111operator< (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
112
Marshall Clow9e1b8452015-02-18 17:51:56 +0000113template <class _Tp, class _Container /*= deque<_Tp>*/>
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000114class _LIBCPP_TEMPLATE_VIS stack
Howard Hinnantc51e1022010-05-11 19:42:16 +0000115{
116public:
117 typedef _Container container_type;
118 typedef typename container_type::value_type value_type;
119 typedef typename container_type::reference reference;
120 typedef typename container_type::const_reference const_reference;
121 typedef typename container_type::size_type size_type;
Marshall Clowb8825f02016-03-14 17:58:11 +0000122 static_assert((is_same<_Tp, value_type>::value), "" );
Louis Dionne173f29e2019-05-29 16:01:36 +0000123
Howard Hinnantc51e1022010-05-11 19:42:16 +0000124protected:
125 container_type c;
126
127public:
Howard Hinnant186dca82010-09-23 17:31:07 +0000128 _LIBCPP_INLINE_VISIBILITY
Howard Hinnante0da4a12011-06-04 22:09:19 +0000129 stack()
130 _NOEXCEPT_(is_nothrow_default_constructible<container_type>::value)
131 : c() {}
132
133 _LIBCPP_INLINE_VISIBILITY
134 stack(const stack& __q) : c(__q.c) {}
135
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000136 _LIBCPP_INLINE_VISIBILITY
137 stack& operator=(const stack& __q) {c = __q.c; return *this;}
138
139
140#ifndef _LIBCPP_CXX03_LANG
Howard Hinnante0da4a12011-06-04 22:09:19 +0000141 _LIBCPP_INLINE_VISIBILITY
142 stack(stack&& __q)
143 _NOEXCEPT_(is_nothrow_move_constructible<container_type>::value)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000144 : c(_VSTD::move(__q.c)) {}
Howard Hinnante0da4a12011-06-04 22:09:19 +0000145
146 _LIBCPP_INLINE_VISIBILITY
Howard Hinnante0da4a12011-06-04 22:09:19 +0000147 stack& operator=(stack&& __q)
148 _NOEXCEPT_(is_nothrow_move_assignable<container_type>::value)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000149 {c = _VSTD::move(__q.c); return *this;}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000150
151 _LIBCPP_INLINE_VISIBILITY
152 explicit stack(container_type&& __c) : c(_VSTD::move(__c)) {}
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400153#endif // _LIBCPP_CXX03_LANG
Howard Hinnante0da4a12011-06-04 22:09:19 +0000154
Howard Hinnant186dca82010-09-23 17:31:07 +0000155 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000156 explicit stack(const container_type& __c) : c(__c) {}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000157
Howard Hinnantc51e1022010-05-11 19:42:16 +0000158 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000159 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000160 explicit stack(const _Alloc& __a,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500161 _EnableIf<uses_allocator<container_type, _Alloc>::value>* = 0)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000162 : c(__a) {}
163 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000164 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000165 stack(const container_type& __c, const _Alloc& __a,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500166 _EnableIf<uses_allocator<container_type, _Alloc>::value>* = 0)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000167 : c(__c, __a) {}
168 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000169 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000170 stack(const stack& __s, const _Alloc& __a,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500171 _EnableIf<uses_allocator<container_type, _Alloc>::value>* = 0)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000172 : c(__s.c, __a) {}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000173#ifndef _LIBCPP_CXX03_LANG
Howard Hinnantc51e1022010-05-11 19:42:16 +0000174 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000175 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000176 stack(container_type&& __c, const _Alloc& __a,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500177 _EnableIf<uses_allocator<container_type, _Alloc>::value>* = 0)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000178 : c(_VSTD::move(__c), __a) {}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000179 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000180 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000181 stack(stack&& __s, const _Alloc& __a,
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500182 _EnableIf<uses_allocator<container_type, _Alloc>::value>* = 0)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000183 : c(_VSTD::move(__s.c), __a) {}
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400184#endif // _LIBCPP_CXX03_LANG
Howard Hinnantc51e1022010-05-11 19:42:16 +0000185
Marshall Clow425f5752017-11-15 05:51:26 +0000186 _LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000187 bool empty() const {return c.empty();}
Howard Hinnant186dca82010-09-23 17:31:07 +0000188 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000189 size_type size() const {return c.size();}
Howard Hinnant186dca82010-09-23 17:31:07 +0000190 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000191 reference top() {return c.back();}
Howard Hinnant186dca82010-09-23 17:31:07 +0000192 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000193 const_reference top() const {return c.back();}
194
Howard Hinnant186dca82010-09-23 17:31:07 +0000195 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000196 void push(const value_type& __v) {c.push_back(__v);}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000197#ifndef _LIBCPP_CXX03_LANG
Howard Hinnant186dca82010-09-23 17:31:07 +0000198 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000199 void push(value_type&& __v) {c.push_back(_VSTD::move(__v));}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000200
Howard Hinnant186dca82010-09-23 17:31:07 +0000201 template <class... _Args>
202 _LIBCPP_INLINE_VISIBILITY
Marshall Clowea52cc42017-01-24 23:09:12 +0000203#if _LIBCPP_STD_VER > 14
Marshall Clow88746852018-01-24 22:42:25 +0000204 decltype(auto) emplace(_Args&&... __args)
Eric Fiselier34ba5b92016-07-21 03:20:17 +0000205 { return c.emplace_back(_VSTD::forward<_Args>(__args)...);}
Marshall Clowea52cc42017-01-24 23:09:12 +0000206#else
207 void emplace(_Args&&... __args)
208 { c.emplace_back(_VSTD::forward<_Args>(__args)...);}
209#endif
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400210#endif // _LIBCPP_CXX03_LANG
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000211
Howard Hinnant186dca82010-09-23 17:31:07 +0000212 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000213 void pop() {c.pop_back();}
214
Howard Hinnant186dca82010-09-23 17:31:07 +0000215 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000216 void swap(stack& __s)
Howard Hinnante0da4a12011-06-04 22:09:19 +0000217 _NOEXCEPT_(__is_nothrow_swappable<container_type>::value)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000218 {
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000219 using _VSTD::swap;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000220 swap(c, __s.c);
221 }
222
223 template <class T1, class _C1>
224 friend
225 bool
226 operator==(const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
Howard Hinnant3b6579a2010-08-22 00:02:43 +0000227
Howard Hinnantc51e1022010-05-11 19:42:16 +0000228 template <class T1, class _C1>
229 friend
230 bool
231 operator< (const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
232};
233
Louis Dionned59f8a52021-08-17 11:59:07 -0400234#if _LIBCPP_STD_VER >= 17
Marshall Clow592d9952018-05-22 01:57:53 +0000235template<class _Container,
Louis Dionne25547162021-08-17 12:26:09 -0400236 class = enable_if_t<!__is_allocator<_Container>::value>
Marshall Clow592d9952018-05-22 01:57:53 +0000237>
238stack(_Container)
239 -> stack<typename _Container::value_type, _Container>;
Louis Dionne173f29e2019-05-29 16:01:36 +0000240
Marshall Clow592d9952018-05-22 01:57:53 +0000241template<class _Container,
242 class _Alloc,
Louis Dionne25547162021-08-17 12:26:09 -0400243 class = enable_if_t<!__is_allocator<_Container>::value>,
244 class = enable_if_t<uses_allocator<_Container, _Alloc>::value>
Louis Dionne173f29e2019-05-29 16:01:36 +0000245 >
Marshall Clow592d9952018-05-22 01:57:53 +0000246stack(_Container, _Alloc)
247 -> stack<typename _Container::value_type, _Container>;
248#endif
249
Howard Hinnantc51e1022010-05-11 19:42:16 +0000250template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000251inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000252bool
253operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
254{
255 return __x.c == __y.c;
256}
257
258template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000259inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000260bool
261operator< (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
262{
263 return __x.c < __y.c;
264}
265
266template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000267inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000268bool
269operator!=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
270{
271 return !(__x == __y);
272}
273
274template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000275inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000276bool
277operator> (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
278{
279 return __y < __x;
280}
281
282template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000283inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000284bool
285operator>=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
286{
287 return !(__x < __y);
288}
289
290template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000291inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000292bool
293operator<=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
294{
295 return !(__y < __x);
296}
297
298template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000299inline _LIBCPP_INLINE_VISIBILITY
Arthur O'Dwyer56226762021-03-03 23:02:20 -0500300_EnableIf<__is_swappable<_Container>::value, void>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000301swap(stack<_Tp, _Container>& __x, stack<_Tp, _Container>& __y)
Howard Hinnante0da4a12011-06-04 22:09:19 +0000302 _NOEXCEPT_(_NOEXCEPT_(__x.swap(__y)))
Howard Hinnantc51e1022010-05-11 19:42:16 +0000303{
304 __x.swap(__y);
305}
306
307template <class _Tp, class _Container, class _Alloc>
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000308struct _LIBCPP_TEMPLATE_VIS uses_allocator<stack<_Tp, _Container>, _Alloc>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000309 : public uses_allocator<_Container, _Alloc>
310{
311};
312
313_LIBCPP_END_NAMESPACE_STD
314
Louis Dionne2b1ceaa2021-04-20 12:03:32 -0400315#endif // _LIBCPP_STACK