blob: 64fd65215d9994c8bd3bac850268c50f647066cf [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);
58 template <class... Args> void emplace(Args&&... args);
59 void pop();
60
Howard Hinnante0da4a12011-06-04 22:09:19 +000061 void swap(stack& c) noexcept(noexcept(swap(c, q.c)));
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
Marshall Clow9e1b8452015-02-18 17:51:56 +000094template <class _Tp, class _Container = deque<_Tp> > class _LIBCPP_TYPE_VIS_ONLY 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>*/>
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000107class _LIBCPP_TYPE_VIS_ONLY 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
129#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
130 _LIBCPP_INLINE_VISIBILITY
131 stack(stack&& __q)
132 _NOEXCEPT_(is_nothrow_move_constructible<container_type>::value)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000133 : c(_VSTD::move(__q.c)) {}
Howard Hinnante0da4a12011-06-04 22:09:19 +0000134#endif // _LIBCPP_HAS_NO_RVALUE_REFERENCES
135
136 _LIBCPP_INLINE_VISIBILITY
137 stack& operator=(const stack& __q) {c = __q.c; return *this;}
138
139#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
140 _LIBCPP_INLINE_VISIBILITY
141 stack& operator=(stack&& __q)
142 _NOEXCEPT_(is_nothrow_move_assignable<container_type>::value)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000143 {c = _VSTD::move(__q.c); return *this;}
Howard Hinnante0da4a12011-06-04 22:09:19 +0000144#endif // _LIBCPP_HAS_NO_RVALUE_REFERENCES
145
Howard Hinnant186dca82010-09-23 17:31:07 +0000146 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000147 explicit stack(const container_type& __c) : c(__c) {}
Howard Hinnant74279a52010-09-04 23:28:19 +0000148#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
Howard Hinnant186dca82010-09-23 17:31:07 +0000149 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000150 explicit stack(container_type&& __c) : c(_VSTD::move(__c)) {}
Howard Hinnant74279a52010-09-04 23:28:19 +0000151#endif // _LIBCPP_HAS_NO_RVALUE_REFERENCES
Howard Hinnantc51e1022010-05-11 19:42:16 +0000152 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000153 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000154 explicit stack(const _Alloc& __a,
155 typename enable_if<uses_allocator<container_type,
156 _Alloc>::value>::type* = 0)
157 : c(__a) {}
158 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000159 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000160 stack(const container_type& __c, const _Alloc& __a,
161 typename enable_if<uses_allocator<container_type,
162 _Alloc>::value>::type* = 0)
163 : c(__c, __a) {}
164 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000165 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000166 stack(const stack& __s, const _Alloc& __a,
167 typename enable_if<uses_allocator<container_type,
168 _Alloc>::value>::type* = 0)
169 : c(__s.c, __a) {}
Howard Hinnant74279a52010-09-04 23:28:19 +0000170#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
Howard Hinnantc51e1022010-05-11 19:42:16 +0000171 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000172 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000173 stack(container_type&& __c, const _Alloc& __a,
174 typename enable_if<uses_allocator<container_type,
175 _Alloc>::value>::type* = 0)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000176 : c(_VSTD::move(__c), __a) {}
Howard Hinnantc51e1022010-05-11 19:42:16 +0000177 template <class _Alloc>
Howard Hinnant186dca82010-09-23 17:31:07 +0000178 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000179 stack(stack&& __s, const _Alloc& __a,
180 typename enable_if<uses_allocator<container_type,
181 _Alloc>::value>::type* = 0)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000182 : c(_VSTD::move(__s.c), __a) {}
Howard Hinnant74279a52010-09-04 23:28:19 +0000183#endif // _LIBCPP_HAS_NO_RVALUE_REFERENCES
Howard Hinnantc51e1022010-05-11 19:42:16 +0000184
Howard Hinnant186dca82010-09-23 17:31:07 +0000185 _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);}
Howard Hinnant74279a52010-09-04 23:28:19 +0000196#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
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));}
Howard Hinnant74279a52010-09-04 23:28:19 +0000199#ifndef _LIBCPP_HAS_NO_VARIADICS
Howard Hinnant186dca82010-09-23 17:31:07 +0000200 template <class... _Args>
201 _LIBCPP_INLINE_VISIBILITY
202 void emplace(_Args&&... __args)
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000203 {c.emplace_back(_VSTD::forward<_Args>(__args)...);}
Howard Hinnant74279a52010-09-04 23:28:19 +0000204#endif // _LIBCPP_HAS_NO_VARIADICS
205#endif // _LIBCPP_HAS_NO_RVALUE_REFERENCES
Howard Hinnant186dca82010-09-23 17:31:07 +0000206 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000207 void pop() {c.pop_back();}
208
Howard Hinnant186dca82010-09-23 17:31:07 +0000209 _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000210 void swap(stack& __s)
Howard Hinnante0da4a12011-06-04 22:09:19 +0000211 _NOEXCEPT_(__is_nothrow_swappable<container_type>::value)
Howard Hinnantc51e1022010-05-11 19:42:16 +0000212 {
Howard Hinnantb1ad5a82011-06-30 21:18:19 +0000213 using _VSTD::swap;
Howard Hinnantc51e1022010-05-11 19:42:16 +0000214 swap(c, __s.c);
215 }
216
217 template <class T1, class _C1>
218 friend
219 bool
220 operator==(const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
Howard Hinnant3b6579a2010-08-22 00:02:43 +0000221
Howard Hinnantc51e1022010-05-11 19:42:16 +0000222 template <class T1, class _C1>
223 friend
224 bool
225 operator< (const stack<T1, _C1>& __x, const stack<T1, _C1>& __y);
226};
227
228template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000229inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000230bool
231operator==(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
232{
233 return __x.c == __y.c;
234}
235
236template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000237inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000238bool
239operator< (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
240{
241 return __x.c < __y.c;
242}
243
244template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000245inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000246bool
247operator!=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
248{
249 return !(__x == __y);
250}
251
252template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000253inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000254bool
255operator> (const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
256{
257 return __y < __x;
258}
259
260template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000261inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000262bool
263operator>=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
264{
265 return !(__x < __y);
266}
267
268template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000269inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000270bool
271operator<=(const stack<_Tp, _Container>& __x, const stack<_Tp, _Container>& __y)
272{
273 return !(__y < __x);
274}
275
276template <class _Tp, class _Container>
Howard Hinnant186dca82010-09-23 17:31:07 +0000277inline _LIBCPP_INLINE_VISIBILITY
Howard Hinnantc51e1022010-05-11 19:42:16 +0000278void
279swap(stack<_Tp, _Container>& __x, stack<_Tp, _Container>& __y)
Howard Hinnante0da4a12011-06-04 22:09:19 +0000280 _NOEXCEPT_(_NOEXCEPT_(__x.swap(__y)))
Howard Hinnantc51e1022010-05-11 19:42:16 +0000281{
282 __x.swap(__y);
283}
284
285template <class _Tp, class _Container, class _Alloc>
Howard Hinnanta37d3cf2013-08-12 18:38:34 +0000286struct _LIBCPP_TYPE_VIS_ONLY uses_allocator<stack<_Tp, _Container>, _Alloc>
Howard Hinnantc51e1022010-05-11 19:42:16 +0000287 : public uses_allocator<_Container, _Alloc>
288{
289};
290
291_LIBCPP_END_NAMESPACE_STD
292
293#endif // _LIBCPP_STACK