libstdc++-v3/include/tr1/array

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