libstdc++-v3/include/tr1_impl/array

   1 // class template array -*- C++ -*-
   2
   3 // Copyright (C) 2007 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, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  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 /** @file tr1_impl/array
  31  *  This is an internal header file, included by other library headers.
  32  *  You should not attempt to use it directly.
  33  */
  34
  35 namespace std
  36 {
  37 _GLIBCXX_BEGIN_NAMESPACE_TR1
  38
  39   /// @brief  struct array.
  40   /// NB: Requires complete type _Tp.
  41   template<typename _Tp, std::size_t _Nm>
  42     struct array
  43     {
  44       typedef _Tp                                     value_type;
  45       typedef value_type&                             reference;
  46       typedef const value_type&                       const_reference;
  47       typedef value_type*                             iterator;
  48       typedef const value_type*                       const_iterator;
  49       typedef std::size_t                             size_type;
  50       typedef std::ptrdiff_t                          difference_type;
  51       typedef std::reverse_iterator<iterator>         reverse_iterator;
  52       typedef std::reverse_iterator<const_iterator>   const_reverse_iterator;
  53
  54       // Support for zero-sized arrays mandatory.
  55       value_type _M_instance[_Nm ? _Nm : 1] __attribute__((__aligned__));
  56
  57       // No explicit construct/copy/destroy for aggregate type.
  58
  59       void
  60       assign(const value_type& __u)
  61       { std::fill_n(begin(), size(), __u); }
  62
  63       void
  64       swap(array& __other)
  65       { std::swap_ranges(begin(), end(), __other.begin()); }
  66
  67       // Iterators.
  68       iterator
  69       begin()
  70       { return iterator(&_M_instance[0]); }
  71
  72       const_iterator
  73       begin() const
  74       { return const_iterator(&_M_instance[0]); }
  75
  76       iterator
  77       end()
  78       { return iterator(&_M_instance[_Nm]); }
  79
  80       const_iterator
  81       end() const
  82       { return const_iterator(&_M_instance[_Nm]); }
  83
  84       reverse_iterator
  85       rbegin()
  86       { return reverse_iterator(end()); }
  87
  88       const_reverse_iterator
  89       rbegin() const
  90       { return const_reverse_iterator(end()); }
  91
  92       reverse_iterator
  93       rend()
  94       { return reverse_iterator(begin()); }
  95
  96       const_reverse_iterator
  97       rend() const
  98       { return const_reverse_iterator(begin()); }
  99
 100       // Capacity.
 101       size_type
 102       size() const { return _Nm; }
 103
 104       size_type
 105       max_size() const { return _Nm; }
 106
 107       bool
 108       empty() const { return size() == 0; }
 109
 110       // Element access.
 111       reference
 112       operator[](size_type __n)
 113       { return _M_instance[__n]; }
 114
 115       const_reference
 116       operator[](size_type __n) const
 117       { return _M_instance[__n]; }
 118
 119       reference
 120       at(size_type __n)
 121       {
 122         _M_check<_Nm>(__n);
 123         return _M_instance[__n];
 124       }
 125
 126       const_reference
 127       at(size_type __n) const
 128       {
 129         _M_check<_Nm>(__n);
 130         return _M_instance[__n];
 131       }
 132
 133       reference
 134       front()
 135       { return *begin(); }
 136
 137       const_reference
 138       front() const
 139       { return *begin(); }
 140
 141       reference
 142       back()
 143       { return _Nm ? *(end() - 1) : *end(); }
 144
 145       const_reference
 146       back() const
 147       { return _Nm ? *(end() - 1) : *end(); }
 148
 149       _Tp*
 150       data()
 151       { return &_M_instance[0]; }
 152
 153       const _Tp*
 154       data() const
 155       { return &_M_instance[0]; }
 156
 157     private:
 158       template<std::size_t _Mm>
 159         typename __gnu_cxx::__enable_if<_Mm, void>::__type
 160         _M_check(size_type __n) const
 161         {
 162           if (__builtin_expect(__n >= _Mm, false))
 163             std::__throw_out_of_range(__N("array::_M_check"));
 164         }
 165
 166       // Avoid "unsigned comparison with zero" warnings.
 167       template<std::size_t _Mm>
 168         typename __gnu_cxx::__enable_if<!_Mm, void>::__type
 169         _M_check(size_type) const
 170         { std::__throw_out_of_range(__N("array::_M_check")); }
 171     };
 172
 173   // Array comparisons.
 174   template<typename _Tp, std::size_t _Nm>
 175     inline bool
 176     operator==(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
 177     { return std::equal(__one.begin(), __one.end(), __two.begin()); }
 178
 179   template<typename _Tp, std::size_t _Nm>
 180     inline bool
 181     operator!=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
 182     { return !(__one == __two); }
 183
 184   template<typename _Tp, std::size_t _Nm>
 185     inline bool
 186     operator<(const array<_Tp, _Nm>& __a, const array<_Tp, _Nm>& __b)
 187     {
 188       return std::lexicographical_compare(__a.begin(), __a.end(),
 189                                           __b.begin(), __b.end());
 190     }
 191
 192   template<typename _Tp, std::size_t _Nm>
 193     inline bool
 194     operator>(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
 195     { return __two < __one; }
 196
 197   template<typename _Tp, std::size_t _Nm>
 198     inline bool
 199     operator<=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
 200     { return !(__one > __two); }
 201
 202   template<typename _Tp, std::size_t _Nm>
 203     inline bool
 204     operator>=(const array<_Tp, _Nm>& __one, const array<_Tp, _Nm>& __two)
 205     { return !(__one < __two); }
 206
 207   // Specialized algorithms [6.2.2.2].
 208   template<typename _Tp, std::size_t _Nm>
 209     inline void
 210     swap(array<_Tp, _Nm>& __one, array<_Tp, _Nm>& __two)
 211     { std::swap_ranges(__one.begin(), __one.end(), __two.begin()); }
 212
 213   // Tuple interface to class template array [6.2.2.5].
 214   template<typename _Tp> class tuple_size;
 215   template<int _Int, typename _Tp> class tuple_element;
 216
 217   template<typename _Tp, std::size_t _Nm>
 218     struct tuple_size<array<_Tp, _Nm> >
 219     { static const int value = _Nm; };
 220
 221   template<typename _Tp, std::size_t _Nm>
 222     const int tuple_size<array<_Tp, _Nm> >::value;
 223
 224   template<int _Int, typename _Tp, std::size_t _Nm>
 225     struct tuple_element<_Int, array<_Tp, _Nm> >
 226     { typedef _Tp type; };
 227
 228   template<int _Int, typename _Tp, std::size_t _Nm>
 229     inline _Tp&
 230     get(array<_Tp, _Nm>& __arr)
 231     { return __arr[_Int]; }
 232
 233   template<int _Int, typename _Tp, std::size_t _Nm>
 234     inline const _Tp&
 235     get(const array<_Tp, _Nm>& __arr)
 236     { return __arr[_Int]; }
 237
 238 _GLIBCXX_END_NAMESPACE_TR1
 239 }