blob: 0cb4c6ca925eecad6a55fe5be81ecbb4deab816c [file] [log] [blame]
Howard Hinnantc51e1022010-05-11 19:42:16 +00001// -*- C++ -*-
2//===---------------------------- stack -----------------------------------===//
3//
Howard Hinnantc566dc32010-05-11 21:36:01 +00004// The LLVM Compiler Infrastructure
Howard Hinnantc51e1022010-05-11 19:42:16 +00005//
Howard Hinnantee11c312010-11-16 22:09:02 +00006// This file is dual licensed under the MIT and the University of Illinois Open
7// Source Licenses. See LICENSE.TXT for details.
Howard Hinnantc51e1022010-05-11 19:42:16 +00008//
9//===----------------------------------------------------------------------===//
10
11#ifndef _LIBCPP_STACK
12#define _LIBCPP_STACK
13
14/*
15 stack synopsis
16
17namespace std
18{
19
20template <class T, class Container = deque<T>>
21class stack
22{
23public:
24 typedef Container container_type;
25 typedef typename container_type::value_type value_type;
26 typedef typename container_type::reference reference;
27 typedef typename container_type::const_reference const_reference;
28 typedef typename container_type::size_type size_type;
29
30protected:
31 container_type c;
32
33public:
Howard Hinnante0da4a12011-06-04 22:09:19 +000034 stack() = default;
35 ~stack() = default;
36
37 stack(const stack& q) = default;
38 stack(stack&& q) = default;
39
40 stack& operator=(const stack& q) = default;
41 stack& operator=(stack&& q) = default;
42
Howard Hinnantc51e1022010-05-11 19:42:16 +000043 explicit stack(const container_type& c);
44 explicit stack(container_type&& c);
Howard Hinnantc51e1022010-05-11 19:42:16 +000045 template <class Alloc> explicit stack(const Alloc& a);
46 template <class Alloc> stack(const container_type& c, const Alloc& a);
47 template <class Alloc> stack(container_type&& c, const Alloc& a);
Howard Hinnante0da4a12011-06-04 22:09:19 +000048 template <class Alloc> stack(const stack& c, const Alloc& a);
Howard Hinnantc51e1022010-05-11 19:42:16 +000049 template <class Alloc> stack(stack&& c, const Alloc& a);
50
51 bool empty() const;
52 size_type size() const;
53 reference top();
54 const_reference top() const;
55
56 void push(const value_type& x);
57 void push(value_type&& x);
Marshall Clowea52cc42017-01-24 23:09:12 +000058 template <class... Args> reference emplace(Args&&... args); // reference in C++17
Howard Hinnantc51e1022010-05-11 19:42:16 +000059 void pop();
60
Eric Fiselier6bfed252016-04-21 23:38:59 +000061 void swap(stack& c) noexcept(is_nothrow_swappable_v<Container>)
Howard Hinnantc51e1022010-05-11 19:42:16 +000062};
63
64template <class T, class Container>
65 bool operator==(const stack<T, Container>& x, const stack<T, Container>& y);
66template <class T, class Container>
67 bool operator< (const stack<T, Container>& x, const stack<T, Container>& y);
68template <class T, class Container>
69 bool operator!=(const stack<T, Container>& x, const stack<T, Container>& y);
70template <class T, class Container>
71 bool operator> (const stack<T, Container>& x, const stack<T, Container>& y);
72template <class T, class Container>
73 bool operator>=(const stack<T, Container>& x, const stack<T, Container>& y);
74template <class T, class Container>
75 bool operator<=(const stack<T, Container>& x, const stack<T, Container>& y);
76
77template <class T, class Container>
Howard Hinnante0da4a12011-06-04 22:09:19 +000078 void swap(stack<T, Container>& x, stack<T, Container>& y)
79 noexcept(noexcept(x.swap(y)));
Howard Hinnantc51e1022010-05-11 19:42:16 +000080
81} // std
82
83*/
84
85#include <__config>
86#include <deque>
87
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000088#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
Howard Hinnantc51e1022010-05-11 19:42:16 +000089#pragma GCC system_header
Howard Hinnantaaaa52b2011-10-17 20:05:10 +000090#endif
Howard Hinnantc51e1022010-05-11 19:42:16 +000091
92_LIBCPP_BEGIN_NAMESPACE_STD
93
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +000094template <class _Tp, class _Container = deque<_Tp> > class _LIBCPP_TEMPLATE_VIS stack;
Howard Hinnantc51e1022010-05-11 19:42:16 +000095
96template <class _Tp, class _Container>
Howard Hinnanta54386e2012-09-14 00:39:16 +000097_LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +000098bool
99operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
100
101template <class _Tp, class _Container>
Howard Hinnanta54386e2012-09-14 00:39:16 +0000102_LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000103bool
104operator< (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y);
105
Marshall Clow9e1b8452015-02-18 17:51:56 +0000106template <class _Tp, class _Container /*= deque<_Tp>*/>
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000107class _LIBCPP_TEMPLATE_VIS stack
Howard Hinnantc51e1022010-05-11 19:42:16 +0000108{
109public:
110 typedef _Container container_type;
111 typedef typename container_type::value_type value_type;
112 typedef typename container_type::reference reference;
113 typedef typename container_type::const_reference const_reference;
114 typedef typename container_type::size_type size_type;
Marshall Clowb8825f02016-03-14 17:58:11 +0000115 static_assert((is_same<_Tp, value_type>::value), "" );
116
Howard Hinnantc51e1022010-05-11 19:42:16 +0000117protected:
118 container_type c;
119
120public:
Howard Hinnant186dca82010-09-23 17:31:07 +0000121 _LIBCPP_INLINE_VISIBILITY
Howard Hinnante0da4a12011-06-04 22:09:19 +0000122 stack()
123 _NOEXCEPT_(is_nothrow_default_constructible<container_type>::value)
124 : c() {}
125
126 _LIBCPP_INLINE_VISIBILITY
127 stack(const stack& __q) : c(__q.c) {}
128
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000129 _LIBCPP_INLINE_VISIBILITY
130 stack& operator=(const stack& __q) {c = __q.c; return *this;}
131
132
133#ifndef _LIBCPP_CXX03_LANG
Howard Hinnante0da4a12011-06-04 22:09:19 +0000134 _LIBCPP_INLINE_VISIBILITY
135 stack(stack&& __q)
136 _NOEXCEPT_(is_nothrow_move_constructible<container_type>::value)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000137 : c(_VSTD::move(__q.c)) {}
Howard Hinnante0da4a12011-06-04 22:09:19 +0000138
139 _LIBCPP_INLINE_VISIBILITY
Howard Hinnante0da4a12011-06-04 22:09:19 +0000140 stack& operator=(stack&& __q)
141 _NOEXCEPT_(is_nothrow_move_assignable<container_type>::value)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000142 {c = _VSTD::move(__q.c); return *this;}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000143
144 _LIBCPP_INLINE_VISIBILITY
145 explicit stack(container_type&& __c) : c(_VSTD::move(__c)) {}
146#endif // _LIBCPP_CXX03_LANG
Howard Hinnante0da4a12011-06-04 22:09:19 +0000147
Howard Hinnant186dca82010-09-23 17:31:07 +0000148 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000149 explicit stack(const container_type& __c) : c(__c) {}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000150
Howard Hinnantc51e1022010-05-11 19:42:16 +0000151 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000152 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000153 explicit stack(const _Alloc& __a,
154 typename enable_if<uses_allocator<container_type,
155 _Alloc>::value>::type* = 0)
156 : c(__a) {}
157 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000158 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000159 stack(const container_type& __c, const _Alloc& __a,
160 typename enable_if<uses_allocator<container_type,
161 _Alloc>::value>::type* = 0)
162 : c(__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 stack& __s, const _Alloc& __a,
166 typename enable_if<uses_allocator<container_type,
167 _Alloc>::value>::type* = 0)
168 : c(__s.c, __a) {}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000169#ifndef _LIBCPP_CXX03_LANG
Howard Hinnantc51e1022010-05-11 19:42:16 +0000170 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000171 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000172 stack(container_type&& __c, const _Alloc& __a,
173 typename enable_if<uses_allocator<container_type,
174 _Alloc>::value>::type* = 0)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000175 : c(_VSTD::move(__c), __a) {}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000176 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000177 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000178 stack(stack&& __s, const _Alloc& __a,
179 typename enable_if<uses_allocator<container_type,
180 _Alloc>::value>::type* = 0)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000181 : c(_VSTD::move(__s.c), __a) {}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000182#endif // _LIBCPP_CXX03_LANG
Howard Hinnantc51e1022010-05-11 19:42:16 +0000183
Marshall Clow425f5752017-11-15 05:51:26 +0000184 _LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000185 bool empty() const {return c.empty();}
Howard Hinnant186dca82010-09-23 17:31:07 +0000186 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000187 size_type size() const {return c.size();}
Howard Hinnant186dca82010-09-23 17:31:07 +0000188 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000189 reference top() {return c.back();}
Howard Hinnant186dca82010-09-23 17:31:07 +0000190 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000191 const_reference top() const {return c.back();}
192
Howard Hinnant186dca82010-09-23 17:31:07 +0000193 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000194 void push(const value_type& __v) {c.push_back(__v);}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000195#ifndef _LIBCPP_CXX03_LANG
Howard Hinnant186dca82010-09-23 17:31:07 +0000196 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000197 void push(value_type&& __v) {c.push_back(_VSTD::move(__v));}
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000198
Howard Hinnant186dca82010-09-23 17:31:07 +0000199 template <class... _Args>
200 _LIBCPP_INLINE_VISIBILITY
Marshall Clowea52cc42017-01-24 23:09:12 +0000201#if _LIBCPP_STD_VER > 14
Eric Fiselier34ba5b92016-07-21 03:20:17 +0000202 reference emplace(_Args&&... __args)
203 { return c.emplace_back(_VSTD::forward<_Args>(__args)...);}
Marshall Clowea52cc42017-01-24 23:09:12 +0000204#else
205 void emplace(_Args&&... __args)
206 { c.emplace_back(_VSTD::forward<_Args>(__args)...);}
207#endif
Eric Fiselier33cc2f02017-04-18 21:16:26 +0000208#endif // _LIBCPP_CXX03_LANG
209
Howard Hinnant186dca82010-09-23 17:31:07 +0000210 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000211 void pop() {c.pop_back();}
212
Howard Hinnant186dca82010-09-23 17:31:07 +0000213 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000214 void swap(stack& __s)
Howard Hinnante0da4a12011-06-04 22:09:19 +0000215 _NOEXCEPT_(__is_nothrow_swappable<container_type>::value)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000216 {
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000217 using _VSTD::swap;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000218 swap(c, __s.c);
219 }
220
221 template <class T1, class _C1>
222 friend
223 bool
224 operator==(const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
Howard Hinnant3b6579a2010-08-22 00:02:43 +0000225
Howard Hinnantc51e1022010-05-11 19:42:16 +0000226 template <class T1, class _C1>
227 friend
228 bool
229 operator< (const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
230};
231
232template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000233inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000234bool
235operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
236{
237 return __x.c == __y.c;
238}
239
240template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000241inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000242bool
243operator< (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
244{
245 return __x.c < __y.c;
246}
247
248template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000249inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000250bool
251operator!=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
252{
253 return !(__x == __y);
254}
255
256template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000257inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000258bool
259operator> (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
260{
261 return __y < __x;
262}
263
264template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000265inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000266bool
267operator>=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
268{
269 return !(__x < __y);
270}
271
272template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000273inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000274bool
275operator<=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
276{
277 return !(__y < __x);
278}
279
280template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000281inline _LIBCPP_INLINE_VISIBILITY
Eric Fiselier6bfed252016-04-21 23:38:59 +0000282typename enable_if<
283 __is_swappable<_Container>::value,
284 void
285>::type
Howard Hinnantc51e1022010-05-11 19:42:16 +0000286swap(stack<_Tp, _Container>& __x, stack<_Tp, _Container>& __y)
Howard Hinnante0da4a12011-06-04 22:09:19 +0000287 _NOEXCEPT_(_NOEXCEPT_(__x.swap(__y)))
Howard Hinnantc51e1022010-05-11 19:42:16 +0000288{
289 __x.swap(__y);
290}
291
292template <class _Tp, class _Container, class _Alloc>
Eric Fiselierb5eb1bf2017-01-04 23:56:00 +0000293struct _LIBCPP_TEMPLATE_VIS uses_allocator<stack<_Tp, _Container>, _Alloc>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000294 : public uses_allocator<_Container, _Alloc>
295{
296};
297
298_LIBCPP_END_NAMESPACE_STD
299
300#endif // _LIBCPP_STACK