blob: 888fac21e5349ff276be0eb9edd6366cfd0678a6 [file] [log] [blame]
Howard Hinnantbc8d3f92010-05-11 19:42:16 +00001// -*- C++ -*-
2//===---------------------------- array -----------------------------------===//
3//
Howard Hinnantf5256e12010-05-11 21:36:01 +00004// The LLVM Compiler Infrastructure
Howard Hinnantbc8d3f92010-05-11 19:42:16 +00005//
Howard Hinnantb64f8b02010-11-16 22:09:02 +00006// This file is dual licensed under the MIT and the University of Illinois Open
7// Source Licenses. See LICENSE.TXT for details.
Howard Hinnantbc8d3f92010-05-11 19:42:16 +00008//
9//===----------------------------------------------------------------------===//
10
11#ifndef _LIBCPP_ARRAY
12#define _LIBCPP_ARRAY
13
14/*
15 array synopsis
16
17namespace std
18{
Howard Hinnant324bb032010-08-22 00:02:43 +000019template <class T, size_t N >
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000020struct array
Howard Hinnant324bb032010-08-22 00:02:43 +000021{
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;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000030 typedef T* pointer;
31 typedef const T* const_pointer;
Howard Hinnant324bb032010-08-22 00:02:43 +000032 typedef std::reverse_iterator<iterator> reverse_iterator;
33 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000034
Howard Hinnant324bb032010-08-22 00:02:43 +000035 // No explicit construct/copy/destroy for aggregate type
36 void fill(const T& u);
Howard Hinnantf0562af2011-05-31 21:06:33 +000037 void swap(array& a) noexcept(noexcept(swap(declval<T&>(), declval<T&>())));
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000038
Howard Hinnant324bb032010-08-22 00:02:43 +000039 // iterators:
Howard Hinnantf0562af2011-05-31 21:06:33 +000040 iterator begin() noexcept;
41 const_iterator begin() const noexcept;
42 iterator end() noexcept;
43 const_iterator end() const noexcept;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000044
Howard Hinnantf0562af2011-05-31 21:06:33 +000045 reverse_iterator rbegin() noexcept;
46 const_reverse_iterator rbegin() const noexcept;
47 reverse_iterator rend() noexcept;
48 const_reverse_iterator rend() const noexcept;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000049
Howard Hinnantf0562af2011-05-31 21:06:33 +000050 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;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000054
Howard Hinnant324bb032010-08-22 00:02:43 +000055 // capacity:
Howard Hinnantf0562af2011-05-31 21:06:33 +000056 constexpr size_type size() const noexcept;
57 constexpr size_type max_size() const noexcept;
58 bool empty() const noexcept;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000059
Howard Hinnant324bb032010-08-22 00:02:43 +000060 // element access:
61 reference operator[](size_type n);
62 const_reference operator[](size_type n) const;
63 const_reference at(size_type n) const;
64 reference at(size_type n);
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000065
Howard Hinnant324bb032010-08-22 00:02:43 +000066 reference front();
67 const_reference front() const;
68 reference back();
69 const_reference back() const;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000070
Howard Hinnantf0562af2011-05-31 21:06:33 +000071 T* data() noexcept;
72 const T* data() const noexcept;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000073};
74
Howard Hinnant324bb032010-08-22 00:02:43 +000075template <class T, size_t N>
76 bool operator==(const array<T,N>& x, const array<T,N>& y);
77template <class T, size_t N>
78 bool operator!=(const array<T,N>& x, const array<T,N>& y);
79template <class T, size_t N>
80 bool operator<(const array<T,N>& x, const array<T,N>& y);
81template <class T, size_t N>
82 bool operator>(const array<T,N>& x, const array<T,N>& y);
83template <class T, size_t N>
84 bool operator<=(const array<T,N>& x, const array<T,N>& y);
85template <class T, size_t N>
86 bool operator>=(const array<T,N>& x, const array<T,N>& y);
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000087
Howard Hinnant324bb032010-08-22 00:02:43 +000088template <class T, size_t N >
Howard Hinnantf0562af2011-05-31 21:06:33 +000089 void swap(array<T,N>& x, array<T,N>& y) noexcept(noexcept(x.swap(y)));
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000090
Howard Hinnant324bb032010-08-22 00:02:43 +000091template <class T> class tuple_size;
92template <int I, class T> class tuple_element;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000093template <class T, size_t N> struct tuple_size<array<T, N>>;
Howard Hinnant324bb032010-08-22 00:02:43 +000094template <int I, class T, size_t N> struct tuple_element<I, array<T, N>>;
Howard Hinnantf0562af2011-05-31 21:06:33 +000095template <int I, class T, size_t N> T& get(array<T, N>&) noexcept;
96template <int I, class T, size_t N> const T& get(const array<T, N>&) noexcept;
97template <int I, class T, size_t N> T&& get(array<T, N>&&) noexcept;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +000098
99} // std
100
101*/
102
103#include <__config>
104#include <__tuple>
105#include <type_traits>
106#include <utility>
107#include <iterator>
108#include <algorithm>
109#include <stdexcept>
110#if defined(_LIBCPP_NO_EXCEPTIONS)
111 #include <cassert>
112#endif
113
114#pragma GCC system_header
115
116_LIBCPP_BEGIN_NAMESPACE_STD
117
Howard Hinnant324bb032010-08-22 00:02:43 +0000118template <class _Tp, size_t _Size>
Howard Hinnant333f50d2010-09-21 20:16:37 +0000119struct _LIBCPP_VISIBLE array
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000120{
121 // types:
122 typedef array __self;
Howard Hinnant324bb032010-08-22 00:02:43 +0000123 typedef _Tp value_type;
124 typedef value_type& reference;
125 typedef const value_type& const_reference;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000126 typedef value_type* iterator;
127 typedef const value_type* const_iterator;
128 typedef value_type* pointer;
129 typedef const value_type* const_pointer;
Howard Hinnant324bb032010-08-22 00:02:43 +0000130 typedef size_t size_type;
131 typedef ptrdiff_t difference_type;
132 typedef std::reverse_iterator<iterator> reverse_iterator;
133 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000134
135 value_type __elems_[_Size > 0 ? _Size : 1];
136
Howard Hinnant324bb032010-08-22 00:02:43 +0000137 // No explicit construct/copy/destroy for aggregate type
Howard Hinnant333f50d2010-09-21 20:16:37 +0000138 _LIBCPP_INLINE_VISIBILITY void fill(const value_type& __u)
139 {_STD::fill_n(__elems_, _Size, __u);}
Howard Hinnantf0562af2011-05-31 21:06:33 +0000140 _LIBCPP_INLINE_VISIBILITY
141 void swap(array& __a) _NOEXCEPT_(__is_nothrow_swappable<_Tp>::value)
Howard Hinnant333f50d2010-09-21 20:16:37 +0000142 {_STD::swap_ranges(__elems_, __elems_ + _Size, __a.__elems_);}
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000143
Howard Hinnant324bb032010-08-22 00:02:43 +0000144 // iterators:
Howard Hinnantf0562af2011-05-31 21:06:33 +0000145 _LIBCPP_INLINE_VISIBILITY
146 iterator begin() _NOEXCEPT {return iterator(__elems_);}
147 _LIBCPP_INLINE_VISIBILITY
148 const_iterator begin() const _NOEXCEPT {return const_iterator(__elems_);}
149 _LIBCPP_INLINE_VISIBILITY
150 iterator end() _NOEXCEPT {return iterator(__elems_ + _Size);}
151 _LIBCPP_INLINE_VISIBILITY
152 const_iterator end() const _NOEXCEPT {return const_iterator(__elems_ + _Size);}
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000153
Howard Hinnantf0562af2011-05-31 21:06:33 +0000154 _LIBCPP_INLINE_VISIBILITY
155 reverse_iterator rbegin() _NOEXCEPT {return reverse_iterator(end());}
156 _LIBCPP_INLINE_VISIBILITY
157 const_reverse_iterator rbegin() const _NOEXCEPT {return const_reverse_iterator(end());}
158 _LIBCPP_INLINE_VISIBILITY
159 reverse_iterator rend() _NOEXCEPT {return reverse_iterator(begin());}
160 _LIBCPP_INLINE_VISIBILITY
161 const_reverse_iterator rend() const _NOEXCEPT {return const_reverse_iterator(begin());}
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000162
Howard Hinnantf0562af2011-05-31 21:06:33 +0000163 _LIBCPP_INLINE_VISIBILITY
164 const_iterator cbegin() const _NOEXCEPT {return begin();}
165 _LIBCPP_INLINE_VISIBILITY
166 const_iterator cend() const _NOEXCEPT {return end();}
167 _LIBCPP_INLINE_VISIBILITY
168 const_reverse_iterator crbegin() const _NOEXCEPT {return rbegin();}
169 _LIBCPP_INLINE_VISIBILITY
170 const_reverse_iterator crend() const _NOEXCEPT {return rend();}
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000171
Howard Hinnant324bb032010-08-22 00:02:43 +0000172 // capacity:
Howard Hinnantf0562af2011-05-31 21:06:33 +0000173 _LIBCPP_INLINE_VISIBILITY
174 /*constexpr*/ size_type size() const _NOEXCEPT {return _Size;}
175 _LIBCPP_INLINE_VISIBILITY
176 /*constexpr*/ size_type max_size() const _NOEXCEPT {return _Size;}
177 _LIBCPP_INLINE_VISIBILITY
178 bool empty() const _NOEXCEPT {return _Size == 0;}
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000179
Howard Hinnant324bb032010-08-22 00:02:43 +0000180 // element access:
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000181 _LIBCPP_INLINE_VISIBILITY reference operator[](size_type __n) {return __elems_[__n];}
182 _LIBCPP_INLINE_VISIBILITY const_reference operator[](size_type __n) const {return __elems_[__n];}
Howard Hinnant324bb032010-08-22 00:02:43 +0000183 reference at(size_type __n);
184 const_reference at(size_type __n) const;
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000185
186 _LIBCPP_INLINE_VISIBILITY reference front() {return __elems_[0];}
187 _LIBCPP_INLINE_VISIBILITY const_reference front() const {return __elems_[0];}
188 _LIBCPP_INLINE_VISIBILITY reference back() {return __elems_[_Size > 0 ? _Size-1 : 0];}
189 _LIBCPP_INLINE_VISIBILITY const_reference back() const {return __elems_[_Size > 0 ? _Size-1 : 0];}
190
Howard Hinnantf0562af2011-05-31 21:06:33 +0000191 _LIBCPP_INLINE_VISIBILITY
192 value_type* data() _NOEXCEPT {return __elems_;}
193 _LIBCPP_INLINE_VISIBILITY
194 const value_type* data() const _NOEXCEPT {return __elems_;}
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000195};
196
Howard Hinnant324bb032010-08-22 00:02:43 +0000197template <class _Tp, size_t _Size>
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000198typename array<_Tp, _Size>::reference
199array<_Tp, _Size>::at(size_type __n)
200{
201 if (__n >= _Size)
202#ifndef _LIBCPP_NO_EXCEPTIONS
203 throw out_of_range("array::at");
204#else
205 assert(!"array::at out_of_range");
206#endif
207 return __elems_[__n];
208}
209
Howard Hinnant324bb032010-08-22 00:02:43 +0000210template <class _Tp, size_t _Size>
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000211typename array<_Tp, _Size>::const_reference
212array<_Tp, _Size>::at(size_type __n) const
213{
214 if (__n >= _Size)
215#ifndef _LIBCPP_NO_EXCEPTIONS
216 throw out_of_range("array::at");
217#else
218 assert(!"array::at out_of_range");
219#endif
220 return __elems_[__n];
221}
222
Howard Hinnant324bb032010-08-22 00:02:43 +0000223template <class _Tp, size_t _Size>
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000224_LIBCPP_INLINE_VISIBILITY inline
225bool
226operator==(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
227{
228 return _STD::equal(__x.__elems_, __x.__elems_ + _Size, __y.__elems_);
229}
230
Howard Hinnant324bb032010-08-22 00:02:43 +0000231template <class _Tp, size_t _Size>
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000232_LIBCPP_INLINE_VISIBILITY inline
233bool
234operator!=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
235{
236 return !(__x == __y);
237}
238
Howard Hinnant324bb032010-08-22 00:02:43 +0000239template <class _Tp, size_t _Size>
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000240_LIBCPP_INLINE_VISIBILITY inline
241bool
242operator<(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
243{
244 return _STD::lexicographical_compare(__x.__elems_, __x.__elems_ + _Size, __y.__elems_, __y.__elems_ + _Size);
245}
246
Howard Hinnant324bb032010-08-22 00:02:43 +0000247template <class _Tp, size_t _Size>
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000248_LIBCPP_INLINE_VISIBILITY inline
249bool
250operator>(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
251{
252 return __y < __x;
253}
254
Howard Hinnant324bb032010-08-22 00:02:43 +0000255template <class _Tp, size_t _Size>
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000256_LIBCPP_INLINE_VISIBILITY inline
257bool
258operator<=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
259{
260 return !(__y < __x);
261}
262
Howard Hinnant324bb032010-08-22 00:02:43 +0000263template <class _Tp, size_t _Size>
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000264_LIBCPP_INLINE_VISIBILITY inline
265bool
266operator>=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
267{
268 return !(__x < __y);
269}
270
Howard Hinnant324bb032010-08-22 00:02:43 +0000271template <class _Tp, size_t _Size>
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000272_LIBCPP_INLINE_VISIBILITY inline
Howard Hinnantaabf2872011-06-01 19:59:32 +0000273typename enable_if
274<
275 __is_swappable<_Tp>::value,
276 void
277>::type
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000278swap(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
Howard Hinnantf0562af2011-05-31 21:06:33 +0000279 _NOEXCEPT_(__is_nothrow_swappable<_Tp>::value)
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000280{
281 __x.swap(__y);
282}
283
284template <class _Tp, size_t _Size>
Howard Hinnant333f50d2010-09-21 20:16:37 +0000285class _LIBCPP_VISIBLE tuple_size<array<_Tp, _Size> >
286 : public integral_constant<size_t, _Size> {};
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000287
288template <class _Tp, size_t _Size>
Howard Hinnant333f50d2010-09-21 20:16:37 +0000289class _LIBCPP_VISIBLE tuple_size<const array<_Tp, _Size> >
290 : public integral_constant<size_t, _Size> {};
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000291
292template <size_t _Ip, class _Tp, size_t _Size>
Howard Hinnant333f50d2010-09-21 20:16:37 +0000293class _LIBCPP_VISIBLE tuple_element<_Ip, array<_Tp, _Size> >
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000294{
295public:
296 typedef _Tp type;
297};
298
299template <size_t _Ip, class _Tp, size_t _Size>
Howard Hinnant333f50d2010-09-21 20:16:37 +0000300class _LIBCPP_VISIBLE tuple_element<_Ip, const array<_Tp, _Size> >
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000301{
302public:
303 typedef const _Tp type;
304};
305
306template <size_t _Ip, class _Tp, size_t _Size>
307_LIBCPP_INLINE_VISIBILITY inline
308_Tp&
Howard Hinnantf0562af2011-05-31 21:06:33 +0000309get(array<_Tp, _Size>& __a) _NOEXCEPT
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000310{
311 return __a[_Ip];
312}
313
314template <size_t _Ip, class _Tp, size_t _Size>
315_LIBCPP_INLINE_VISIBILITY inline
316const _Tp&
Howard Hinnantf0562af2011-05-31 21:06:33 +0000317get(const array<_Tp, _Size>& __a) _NOEXCEPT
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000318{
319 return __a[_Ip];
320}
321
Howard Hinnantcd2254b2010-11-17 19:52:17 +0000322#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
323
324template <size_t _Ip, class _Tp, size_t _Size>
325_LIBCPP_INLINE_VISIBILITY inline
326_Tp&&
Howard Hinnantf0562af2011-05-31 21:06:33 +0000327get(array<_Tp, _Size>&& __a) _NOEXCEPT
Howard Hinnantcd2254b2010-11-17 19:52:17 +0000328{
329 return _STD::move(__a[_Ip]);
330}
331
332#endif // _LIBCPP_HAS_NO_RVALUE_REFERENCES
333
Howard Hinnantbc8d3f92010-05-11 19:42:16 +0000334_LIBCPP_END_NAMESPACE_STD
335
336#endif // _LIBCPP_ARRAY