libstdc++-v3/include/bits/stl_stack.h

   1 // Stack implementation -*- C++ -*-
   2
   3 // Copyright (C) 2001 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 2, or (at your option)
   9 // any later version.
  10
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  19 // USA.
  20
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 /*
  31  *
  32  * Copyright (c) 1994
  33  * Hewlett-Packard Company
  34  *
  35  * Permission to use, copy, modify, distribute and sell this software
  36  * and its documentation for any purpose is hereby granted without fee,
  37  * provided that the above copyright notice appear in all copies and
  38  * that both that copyright notice and this permission notice appear
  39  * in supporting documentation.  Hewlett-Packard Company makes no
  40  * representations about the suitability of this software for any
  41  * purpose.  It is provided "as is" without express or implied warranty.
  42  *
  43  *
  44  * Copyright (c) 1996,1997
  45  * Silicon Graphics Computer Systems, Inc.
  46  *
  47  * Permission to use, copy, modify, distribute and sell this software
  48  * and its documentation for any purpose is hereby granted without fee,
  49  * provided that the above copyright notice appear in all copies and
  50  * that both that copyright notice and this permission notice appear
  51  * in supporting documentation.  Silicon Graphics makes no
  52  * representations about the suitability of this software for any
  53  * purpose.  It is provided "as is" without express or implied warranty.
  54  */
  55
  56 /* NOTE: This is an internal header file, included by other STL headers.
  57  *   You should not attempt to use it directly.
  58  */
  59
  60 #ifndef __SGI_STL_INTERNAL_STACK_H
  61 #define __SGI_STL_INTERNAL_STACK_H
  62
  63 #include <bits/concept_check.h>
  64
  65 namespace std
  66 {
  67
  68 // Forward declarations of operators == and <, needed for friend declaration.
  69
  70 template <class _Tp,
  71           class _Sequence = deque<_Tp> >
  72 class stack;
  73
  74 template <class _Tp, class _Seq>
  75 bool operator==(const stack<_Tp,_Seq>& __x, const stack<_Tp,_Seq>& __y);
  76
  77 template <class _Tp, class _Seq>
  78 bool operator<(const stack<_Tp,_Seq>& __x, const stack<_Tp,_Seq>& __y);
  79
  80
  81 template <class _Tp, class _Sequence>
  82 class stack
  83 {
  84   // concept requirements
  85   __glibcpp_class_requires(_Tp, _SGIAssignableConcept)
  86   __glibcpp_class_requires(_Sequence, _BackInsertionSequenceConcept)
  87   typedef typename _Sequence::value_type _Sequence_value_type;
  88   __glibcpp_class_requires2(_Tp, _Sequence_value_type, _SameTypeConcept);
  89
  90   template <class _Tp1, class _Seq1>
  91   friend bool operator== (const stack<_Tp1, _Seq1>&,
  92                           const stack<_Tp1, _Seq1>&);
  93   template <class _Tp1, class _Seq1>
  94   friend bool operator< (const stack<_Tp1, _Seq1>&,
  95                          const stack<_Tp1, _Seq1>&);
  96 public:
  97   typedef typename _Sequence::value_type      value_type;
  98   typedef typename _Sequence::size_type       size_type;
  99   typedef          _Sequence                  container_type;
 100
 101   typedef typename _Sequence::reference       reference;
 102   typedef typename _Sequence::const_reference const_reference;
 103 protected:
 104   _Sequence c;
 105 public:
 106   stack() : c() {}
 107   explicit stack(const _Sequence& __s) : c(__s) {}
 108
 109   bool empty() const { return c.empty(); }
 110   size_type size() const { return c.size(); }
 111   reference top() { return c.back(); }
 112   const_reference top() const { return c.back(); }
 113   void push(const value_type& __x) { c.push_back(__x); }
 114   void pop() { c.pop_back(); }
 115 };
 116
 117 template <class _Tp, class _Seq>
 118 bool operator==(const stack<_Tp,_Seq>& __x, const stack<_Tp,_Seq>& __y)
 119 {
 120   return __x.c == __y.c;
 121 }
 122
 123 template <class _Tp, class _Seq>
 124 bool operator<(const stack<_Tp,_Seq>& __x, const stack<_Tp,_Seq>& __y)
 125 {
 126   return __x.c < __y.c;
 127 }
 128
 129 template <class _Tp, class _Seq>
 130 bool operator!=(const stack<_Tp,_Seq>& __x, const stack<_Tp,_Seq>& __y)
 131 {
 132   return !(__x == __y);
 133 }
 134
 135 template <class _Tp, class _Seq>
 136 bool operator>(const stack<_Tp,_Seq>& __x, const stack<_Tp,_Seq>& __y)
 137 {
 138   return __y < __x;
 139 }
 140
 141 template <class _Tp, class _Seq>
 142 bool operator<=(const stack<_Tp,_Seq>& __x, const stack<_Tp,_Seq>& __y)
 143 {
 144   return !(__y < __x);
 145 }
 146
 147 template <class _Tp, class _Seq>
 148 bool operator>=(const stack<_Tp,_Seq>& __x, const stack<_Tp,_Seq>& __y)
 149 {
 150   return !(__x < __y);
 151 }
 152
 153 } // namespace std
 154
 155 #endif /* __SGI_STL_INTERNAL_STACK_H */
 156
 157 // Local Variables:
 158 // mode:C++
 159 // End: