1 // Stack implementation -*- C++ -*-
3 // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007
4 // Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 2, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING. If not, write to the Free
19 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction. Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License. This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
34 * Hewlett-Packard Company
36 * Permission to use, copy, modify, distribute and sell this software
37 * and its documentation for any purpose is hereby granted without fee,
38 * provided that the above copyright notice appear in all copies and
39 * that both that copyright notice and this permission notice appear
40 * in supporting documentation. Hewlett-Packard Company makes no
41 * representations about the suitability of this software for any
42 * purpose. It is provided "as is" without express or implied warranty.
45 * Copyright (c) 1996,1997
46 * Silicon Graphics Computer Systems, Inc.
48 * Permission to use, copy, modify, distribute and sell this software
49 * and its documentation for any purpose is hereby granted without fee,
50 * provided that the above copyright notice appear in all copies and
51 * that both that copyright notice and this permission notice appear
52 * in supporting documentation. Silicon Graphics makes no
53 * representations about the suitability of this software for any
54 * purpose. It is provided "as is" without express or implied warranty.
58 * This is an internal header file, included by other library headers.
59 * You should not attempt to use it directly.
63 #define _STL_STACK_H 1
65 #include <bits/concept_check.h>
66 #include <debug/debug.h>
68 _GLIBCXX_BEGIN_NAMESPACE(std
)
71 * @brief A standard container giving FILO behavior.
76 * Meets many of the requirements of a
77 * <a href="tables.html#65">container</a>,
78 * but does not define anything to do with iterators. Very few of the
79 * other standard container interfaces are defined.
81 * This is not a true container, but an @e adaptor. It holds
82 * another container, and provides a wrapper interface to that
83 * container. The wrapper is what enforces strict
84 * first-in-last-out %stack behavior.
86 * The second template parameter defines the type of the underlying
87 * sequence/container. It defaults to std::deque, but it can be
88 * any type that supports @c back, @c push_back, and @c pop_front,
89 * such as std::list, std::vector, or an appropriate user-defined
92 * Members not found in "normal" containers are @c container_type,
93 * which is a typedef for the second Sequence parameter, and @c
94 * push, @c pop, and @c top, which are standard %stack/FILO
97 template<typename _Tp
, typename _Sequence
= deque
<_Tp
> >
100 // concept requirements
101 typedef typename
_Sequence::value_type _Sequence_value_type
;
102 __glibcxx_class_requires(_Tp
, _SGIAssignableConcept
)
103 __glibcxx_class_requires(_Sequence
, _BackInsertionSequenceConcept
)
104 __glibcxx_class_requires2(_Tp
, _Sequence_value_type
, _SameTypeConcept
)
106 template<typename _Tp1
, typename _Seq1
>
108 operator==(const stack
<_Tp1
, _Seq1
>&, const stack
<_Tp1
, _Seq1
>&);
110 template<typename _Tp1
, typename _Seq1
>
112 operator<(const stack
<_Tp1
, _Seq1
>&, const stack
<_Tp1
, _Seq1
>&);
115 typedef typename
_Sequence::value_type value_type
;
116 typedef typename
_Sequence::reference reference
;
117 typedef typename
_Sequence::const_reference const_reference
;
118 typedef typename
_Sequence::size_type size_type
;
119 typedef _Sequence container_type
;
122 // See queue::c for notes on this name.
126 // XXX removed old def ctor, added def arg to this one to match 14882
128 * @brief Default constructor creates no elements.
130 #ifndef __GXX_EXPERIMENTAL_CXX0X__
132 stack(const _Sequence
& __c
= _Sequence())
136 stack(const _Sequence
& __c
)
140 stack(_Sequence
&& __c
= _Sequence())
141 : c(std::move(__c
)) { }
145 * Returns true if the %stack is empty.
149 { return c
.empty(); }
151 /** Returns the number of elements in the %stack. */
157 * Returns a read/write reference to the data at the first
158 * element of the %stack.
163 __glibcxx_requires_nonempty();
168 * Returns a read-only (constant) reference to the data at the first
169 * element of the %stack.
174 __glibcxx_requires_nonempty();
179 * @brief Add data to the top of the %stack.
180 * @param x Data to be added.
182 * This is a typical %stack operation. The function creates an
183 * element at the top of the %stack and assigns the given data
184 * to it. The time complexity of the operation depends on the
185 * underlying sequence.
188 push(const value_type
& __x
)
189 { c
.push_back(__x
); }
191 #ifdef __GXX_EXPERIMENTAL_CXX0X__
193 push(value_type
&& __x
)
194 { c
.push_back(std::move(__x
)); }
198 * @brief Removes first element.
200 * This is a typical %stack operation. It shrinks the %stack
201 * by one. The time complexity of the operation depends on the
202 * underlying sequence.
204 * Note that no data is returned, and if the first element's
205 * data is needed, it should be retrieved before pop() is
211 __glibcxx_requires_nonempty();
215 #ifdef __GXX_EXPERIMENTAL_CXX0X__
223 * @brief Stack equality comparison.
225 * @param y A %stack of the same type as @a x.
226 * @return True iff the size and elements of the stacks are equal.
228 * This is an equivalence relation. Complexity and semantics
229 * depend on the underlying sequence type, but the expected rules
230 * are: this relation is linear in the size of the sequences, and
231 * stacks are considered equivalent if their sequences compare
234 template<typename _Tp
, typename _Seq
>
236 operator==(const stack
<_Tp
, _Seq
>& __x
, const stack
<_Tp
, _Seq
>& __y
)
237 { return __x
.c
== __y
.c
; }
240 * @brief Stack ordering relation.
242 * @param y A %stack of the same type as @a x.
243 * @return True iff @a x is lexicographically less than @a y.
245 * This is an total ordering relation. Complexity and semantics
246 * depend on the underlying sequence type, but the expected rules
247 * are: this relation is linear in the size of the sequences, the
248 * elements must be comparable with @c <, and
249 * std::lexicographical_compare() is usually used to make the
252 template<typename _Tp
, typename _Seq
>
254 operator<(const stack
<_Tp
, _Seq
>& __x
, const stack
<_Tp
, _Seq
>& __y
)
255 { return __x
.c
< __y
.c
; }
257 /// Based on operator==
258 template<typename _Tp
, typename _Seq
>
260 operator!=(const stack
<_Tp
, _Seq
>& __x
, const stack
<_Tp
, _Seq
>& __y
)
261 { return !(__x
== __y
); }
263 /// Based on operator<
264 template<typename _Tp
, typename _Seq
>
266 operator>(const stack
<_Tp
, _Seq
>& __x
, const stack
<_Tp
, _Seq
>& __y
)
267 { return __y
< __x
; }
269 /// Based on operator<
270 template<typename _Tp
, typename _Seq
>
272 operator<=(const stack
<_Tp
, _Seq
>& __x
, const stack
<_Tp
, _Seq
>& __y
)
273 { return !(__y
< __x
); }
275 /// Based on operator<
276 template<typename _Tp
, typename _Seq
>
278 operator>=(const stack
<_Tp
, _Seq
>& __x
, const stack
<_Tp
, _Seq
>& __y
)
279 { return !(__x
< __y
); }
281 #ifdef __GXX_EXPERIMENTAL_CXX0X__
282 template<typename _Tp
, typename _Seq
>
284 swap(stack
<_Tp
, _Seq
>& __x
, stack
<_Tp
, _Seq
>& __y
)
287 template<typename _Tp
, typename _Seq
>
289 swap(stack
<_Tp
, _Seq
>&& __x
, stack
<_Tp
, _Seq
>& __y
)
292 template<typename _Tp
, typename _Seq
>
294 swap(stack
<_Tp
, _Seq
>& __x
, stack
<_Tp
, _Seq
>&& __y
)
298 _GLIBCXX_END_NAMESPACE
300 #endif /* _STL_STACK_H */