contrib/libc++/include/array

   1 // -*- C++ -*-
   2 //===---------------------------- array -----------------------------------===//
   3 //
   4 //                     The LLVM Compiler Infrastructure
   5 //
   6 // This file is dual licensed under the MIT and the University of Illinois Open
   7 // Source Licenses. See LICENSE.TXT for details.
   8 //
   9 //===----------------------------------------------------------------------===//
  10
  11 #ifndef _LIBCPP_ARRAY
  12 #define _LIBCPP_ARRAY
  13
  14 /*
  15     array synopsis
  16
  17 namespace std
  18 {
  19 template <class T, size_t N >
  20 struct array
  21 {
  22     // types:
  23     typedef T & reference;
  24     typedef const T & const_reference;
  25     typedef implementation defined iterator;
  26     typedef implementation defined const_iterator;
  27     typedef size_t size_type;
  28     typedef ptrdiff_t difference_type;
  29     typedef T value_type;
  30     typedef T* pointer;
  31     typedef const T* const_pointer;
  32     typedef std::reverse_iterator<iterator> reverse_iterator;
  33     typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
  34
  35     // No explicit construct/copy/destroy for aggregate type
  36     void fill(const T& u);
  37     void swap(array& a) noexcept(noexcept(swap(declval<T&>(), declval<T&>())));
  38
  39     // iterators:
  40     iterator begin() noexcept;
  41     const_iterator begin() const noexcept;
  42     iterator end() noexcept;
  43     const_iterator end() const noexcept;
  44
  45     reverse_iterator rbegin() noexcept;
  46     const_reverse_iterator rbegin() const noexcept;
  47     reverse_iterator rend() noexcept;
  48     const_reverse_iterator rend() const noexcept;
  49
  50     const_iterator cbegin() const noexcept;
  51     const_iterator cend() const noexcept;
  52     const_reverse_iterator crbegin() const noexcept;
  53     const_reverse_iterator crend() const noexcept;
  54
  55     // capacity:
  56     constexpr size_type size() const noexcept;
  57     constexpr size_type max_size() const noexcept;
  58     constexpr bool empty() const noexcept;
  59
  60     // element access:
  61     reference operator[](size_type n);
  62     const_reference operator[](size_type n) const; // constexpr in C++14
  63     const_reference at(size_type n) const; // constexpr in C++14
  64     reference at(size_type n);
  65
  66     reference front();
  67     const_reference front() const; // constexpr in C++14
  68     reference back();
  69     const_reference back() const; // constexpr in C++14
  70
  71     T* data() noexcept;
  72     const T* data() const noexcept;
  73 };
  74
  75 template <class T, size_t N>
  76   bool operator==(const array<T,N>& x, const array<T,N>& y);
  77 template <class T, size_t N>
  78   bool operator!=(const array<T,N>& x, const array<T,N>& y);
  79 template <class T, size_t N>
  80   bool operator<(const array<T,N>& x, const array<T,N>& y);
  81 template <class T, size_t N>
  82   bool operator>(const array<T,N>& x, const array<T,N>& y);
  83 template <class T, size_t N>
  84   bool operator<=(const array<T,N>& x, const array<T,N>& y);
  85 template <class T, size_t N>
  86   bool operator>=(const array<T,N>& x, const array<T,N>& y);
  87
  88 template <class T, size_t N >
  89   void swap(array<T,N>& x, array<T,N>& y) noexcept(noexcept(x.swap(y)));
  90
  91 template <class T> class tuple_size;
  92 template <size_t I, class T> class tuple_element;
  93 template <class T, size_t N> struct tuple_size<array<T, N>>;
  94 template <size_t I, class T, size_t N> struct tuple_element<I, array<T, N>>;
  95 template <size_t I, class T, size_t N> T& get(array<T, N>&) noexcept; // constexpr in C++14
  96 template <size_t I, class T, size_t N> const T& get(const array<T, N>&) noexcept; // constexpr in C++14
  97 template <size_t I, class T, size_t N> T&& get(array<T, N>&&) noexcept; // constexpr in C++14
  98 template <size_t I, class T, size_t N> const T&& get(const array<T, N>&&) noexcept; // constexpr in C++14
  99
 100 }  // std
 101
 102 */
 103
 104 #include <__config>
 105 #include <__tuple>
 106 #include <type_traits>
 107 #include <utility>
 108 #include <iterator>
 109 #include <algorithm>
 110 #include <stdexcept>
 111 #if defined(_LIBCPP_NO_EXCEPTIONS)
 112     #include <cassert>
 113 #endif
 114
 115 #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
 116 #pragma GCC system_header
 117 #endif
 118
 119 _LIBCPP_BEGIN_NAMESPACE_STD
 120
 121 template <class _Tp, size_t _Size>
 122 struct _LIBCPP_TYPE_VIS_ONLY array
 123 {
 124     // types:
 125     typedef array __self;
 126     typedef _Tp                                   value_type;
 127     typedef value_type&                           reference;
 128     typedef const value_type&                     const_reference;
 129     typedef value_type*                           iterator;
 130     typedef const value_type*                     const_iterator;
 131     typedef value_type*                           pointer;
 132     typedef const value_type*                     const_pointer;
 133     typedef size_t                                size_type;
 134     typedef ptrdiff_t                             difference_type;
 135     typedef std::reverse_iterator<iterator>       reverse_iterator;
 136     typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
 137
 138     value_type __elems_[_Size > 0 ? _Size : 1];
 139
 140     // No explicit construct/copy/destroy for aggregate type
 141     _LIBCPP_INLINE_VISIBILITY void fill(const value_type& __u)
 142         {_VSTD::fill_n(__elems_, _Size, __u);}
 143     _LIBCPP_INLINE_VISIBILITY
 144     void swap(array& __a) _NOEXCEPT_(__is_nothrow_swappable<_Tp>::value)
 145         {_VSTD::swap_ranges(__elems_, __elems_ + _Size, __a.__elems_);}
 146
 147     // iterators:
 148     _LIBCPP_INLINE_VISIBILITY
 149     iterator begin() _NOEXCEPT {return iterator(__elems_);}
 150     _LIBCPP_INLINE_VISIBILITY
 151     const_iterator begin() const _NOEXCEPT {return const_iterator(__elems_);}
 152     _LIBCPP_INLINE_VISIBILITY
 153     iterator end() _NOEXCEPT {return iterator(__elems_ + _Size);}
 154     _LIBCPP_INLINE_VISIBILITY
 155     const_iterator end() const _NOEXCEPT {return const_iterator(__elems_ + _Size);}
 156
 157     _LIBCPP_INLINE_VISIBILITY
 158     reverse_iterator rbegin() _NOEXCEPT {return reverse_iterator(end());}
 159     _LIBCPP_INLINE_VISIBILITY
 160     const_reverse_iterator rbegin() const _NOEXCEPT {return const_reverse_iterator(end());}
 161     _LIBCPP_INLINE_VISIBILITY
 162     reverse_iterator rend() _NOEXCEPT {return reverse_iterator(begin());}
 163     _LIBCPP_INLINE_VISIBILITY
 164     const_reverse_iterator rend() const _NOEXCEPT {return const_reverse_iterator(begin());}
 165
 166     _LIBCPP_INLINE_VISIBILITY
 167     const_iterator cbegin() const _NOEXCEPT {return begin();}
 168     _LIBCPP_INLINE_VISIBILITY
 169     const_iterator cend() const _NOEXCEPT {return end();}
 170     _LIBCPP_INLINE_VISIBILITY
 171     const_reverse_iterator crbegin() const _NOEXCEPT {return rbegin();}
 172     _LIBCPP_INLINE_VISIBILITY
 173     const_reverse_iterator crend() const _NOEXCEPT {return rend();}
 174
 175     // capacity:
 176     _LIBCPP_INLINE_VISIBILITY
 177     _LIBCPP_CONSTEXPR size_type size() const _NOEXCEPT {return _Size;}
 178     _LIBCPP_INLINE_VISIBILITY
 179     _LIBCPP_CONSTEXPR size_type max_size() const _NOEXCEPT {return _Size;}
 180     _LIBCPP_INLINE_VISIBILITY
 181     _LIBCPP_CONSTEXPR bool empty() const _NOEXCEPT {return _Size == 0;}
 182
 183     // element access:
 184     _LIBCPP_INLINE_VISIBILITY reference operator[](size_type __n)             {return __elems_[__n];}
 185     _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_AFTER_CXX11 const_reference operator[](size_type __n) const {return __elems_[__n];}
 186     reference at(size_type __n);
 187     _LIBCPP_CONSTEXPR_AFTER_CXX11 const_reference at(size_type __n) const;
 188
 189     _LIBCPP_INLINE_VISIBILITY reference front()             {return __elems_[0];}
 190     _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_AFTER_CXX11 const_reference front() const {return __elems_[0];}
 191     _LIBCPP_INLINE_VISIBILITY reference back()              {return __elems_[_Size > 0 ? _Size-1 : 0];}
 192     _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_AFTER_CXX11 const_reference back() const  {return __elems_[_Size > 0 ? _Size-1 : 0];}
 193
 194     _LIBCPP_INLINE_VISIBILITY
 195     value_type* data() _NOEXCEPT {return __elems_;}
 196     _LIBCPP_INLINE_VISIBILITY
 197     const value_type* data() const _NOEXCEPT {return __elems_;}
 198 };
 199
 200 template <class _Tp, size_t _Size>
 201 typename array<_Tp, _Size>::reference
 202 array<_Tp, _Size>::at(size_type __n)
 203 {
 204     if (__n >= _Size)
 205 #ifndef _LIBCPP_NO_EXCEPTIONS
 206         throw out_of_range("array::at");
 207 #else
 208         assert(!"array::at out_of_range");
 209 #endif
 210     return __elems_[__n];
 211 }
 212
 213 template <class _Tp, size_t _Size>
 214 _LIBCPP_CONSTEXPR_AFTER_CXX11
 215 typename array<_Tp, _Size>::const_reference
 216 array<_Tp, _Size>::at(size_type __n) const
 217 {
 218     if (__n >= _Size)
 219 #ifndef _LIBCPP_NO_EXCEPTIONS
 220         throw out_of_range("array::at");
 221 #else
 222         assert(!"array::at out_of_range");
 223 #endif
 224     return __elems_[__n];
 225 }
 226
 227 template <class _Tp, size_t _Size>
 228 inline _LIBCPP_INLINE_VISIBILITY
 229 bool
 230 operator==(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
 231 {
 232     return _VSTD::equal(__x.__elems_, __x.__elems_ + _Size, __y.__elems_);
 233 }
 234
 235 template <class _Tp, size_t _Size>
 236 inline _LIBCPP_INLINE_VISIBILITY
 237 bool
 238 operator!=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
 239 {
 240     return !(__x == __y);
 241 }
 242
 243 template <class _Tp, size_t _Size>
 244 inline _LIBCPP_INLINE_VISIBILITY
 245 bool
 246 operator<(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
 247 {
 248     return _VSTD::lexicographical_compare(__x.__elems_, __x.__elems_ + _Size, __y.__elems_, __y.__elems_ + _Size);
 249 }
 250
 251 template <class _Tp, size_t _Size>
 252 inline _LIBCPP_INLINE_VISIBILITY
 253 bool
 254 operator>(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
 255 {
 256     return __y < __x;
 257 }
 258
 259 template <class _Tp, size_t _Size>
 260 inline _LIBCPP_INLINE_VISIBILITY
 261 bool
 262 operator<=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
 263 {
 264     return !(__y < __x);
 265 }
 266
 267 template <class _Tp, size_t _Size>
 268 inline _LIBCPP_INLINE_VISIBILITY
 269 bool
 270 operator>=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
 271 {
 272     return !(__x < __y);
 273 }
 274
 275 template <class _Tp, size_t _Size>
 276 inline _LIBCPP_INLINE_VISIBILITY
 277 typename enable_if
 278 <
 279     __is_swappable<_Tp>::value,
 280     void
 281 >::type
 282 swap(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
 283                                   _NOEXCEPT_(__is_nothrow_swappable<_Tp>::value)
 284 {
 285     __x.swap(__y);
 286 }
 287
 288 template <class _Tp, size_t _Size>
 289 class _LIBCPP_TYPE_VIS_ONLY tuple_size<array<_Tp, _Size> >
 290     : public integral_constant<size_t, _Size> {};
 291
 292 template <size_t _Ip, class _Tp, size_t _Size>
 293 class _LIBCPP_TYPE_VIS_ONLY tuple_element<_Ip, array<_Tp, _Size> >
 294 {
 295 public:
 296     typedef _Tp type;
 297 };
 298
 299 template <size_t _Ip, class _Tp, size_t _Size>
 300 inline _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_AFTER_CXX11
 301 _Tp&
 302 get(array<_Tp, _Size>& __a) _NOEXCEPT
 303 {
 304     static_assert(_Ip < _Size, "Index out of bounds in std::get<> (std::array)");
 305     return __a.__elems_[_Ip];
 306 }
 307
 308 template <size_t _Ip, class _Tp, size_t _Size>
 309 inline _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_AFTER_CXX11
 310 const _Tp&
 311 get(const array<_Tp, _Size>& __a) _NOEXCEPT
 312 {
 313     static_assert(_Ip < _Size, "Index out of bounds in std::get<> (const std::array)");
 314     return __a.__elems_[_Ip];
 315 }
 316
 317 #ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
 318
 319 template <size_t _Ip, class _Tp, size_t _Size>
 320 inline _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_AFTER_CXX11
 321 _Tp&&
 322 get(array<_Tp, _Size>&& __a) _NOEXCEPT
 323 {
 324     static_assert(_Ip < _Size, "Index out of bounds in std::get<> (std::array &&)");
 325     return _VSTD::move(__a.__elems_[_Ip]);
 326 }
 327
 328 template <size_t _Ip, class _Tp, size_t _Size>
 329 inline _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_AFTER_CXX11
 330 const _Tp&&
 331 get(const array<_Tp, _Size>&& __a) _NOEXCEPT
 332 {
 333     static_assert(_Ip < _Size, "Index out of bounds in std::get<> (const std::array &&)");
 334     return _VSTD::move(__a.__elems_[_Ip]);
 335 }
 336
 337 #endif  // _LIBCPP_HAS_NO_RVALUE_REFERENCES
 338
 339 _LIBCPP_END_NAMESPACE_STD
 340
 341 #endif  // _LIBCPP_ARRAY