xref: /llvm-project-15.0.7/libcxx/include/array (revision 0ab5e2cd)
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
17namespace std
18{
19template <class T, size_t N >
20struct 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);
38
39    // iterators:
40    iterator begin();
41    const_iterator begin() const;
42    iterator end();
43    const_iterator end() const;
44
45    reverse_iterator rbegin();
46    const_reverse_iterator rbegin() const;
47    reverse_iterator rend();
48    const_reverse_iterator rend() const;
49
50    const_iterator cbegin() const;
51    const_iterator cend() const;
52    const_reverse_iterator crbegin() const;
53    const_reverse_iterator crend() const;
54
55    // capacity:
56    constexpr size_type size() const;
57    constexpr size_type max_size() const;
58    bool empty() const;
59
60    // 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);
65
66    reference front();
67    const_reference front() const;
68    reference back();
69    const_reference back() const;
70
71    T* data();
72    const T* data() const;
73};
74
75template <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);
87
88template <class T, size_t N >
89  void swap(array<T,N>& x, array<T,N>& y);
90
91template <class T> class tuple_size;
92template <int I, class T> class tuple_element;
93template <class T, size_t N> struct tuple_size<array<T, N>>;
94template <int I, class T, size_t N> struct tuple_element<I, array<T, N>>;
95template <int I, class T, size_t N> T& get(array<T, N>&);
96template <int I, class T, size_t N> const T& get(const array<T, N>&);
97template <int I, class T, size_t N> T&& get(array<T, N>&&);
98
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
118template <class _Tp, size_t _Size>
119struct _LIBCPP_VISIBLE array
120{
121    // types:
122    typedef array __self;
123    typedef _Tp                                   value_type;
124    typedef value_type&                           reference;
125    typedef const value_type&                     const_reference;
126    typedef value_type*                           iterator;
127    typedef const value_type*                     const_iterator;
128    typedef value_type*                           pointer;
129    typedef const value_type*                     const_pointer;
130    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;
134
135    value_type __elems_[_Size > 0 ? _Size : 1];
136
137    // No explicit construct/copy/destroy for aggregate type
138    _LIBCPP_INLINE_VISIBILITY void fill(const value_type& __u)
139        {_STD::fill_n(__elems_, _Size, __u);}
140    _LIBCPP_INLINE_VISIBILITY void swap(array& __a)
141        {_STD::swap_ranges(__elems_, __elems_ + _Size, __a.__elems_);}
142
143    // iterators:
144    _LIBCPP_INLINE_VISIBILITY iterator begin()             {return iterator(__elems_);}
145    _LIBCPP_INLINE_VISIBILITY const_iterator begin() const {return const_iterator(__elems_);}
146    _LIBCPP_INLINE_VISIBILITY iterator end()               {return iterator(__elems_ + _Size);}
147    _LIBCPP_INLINE_VISIBILITY const_iterator end() const   {return const_iterator(__elems_ + _Size);}
148
149    _LIBCPP_INLINE_VISIBILITY reverse_iterator rbegin()             {return reverse_iterator(end());}
150    _LIBCPP_INLINE_VISIBILITY const_reverse_iterator rbegin() const {return const_reverse_iterator(end());}
151    _LIBCPP_INLINE_VISIBILITY reverse_iterator rend()               {return reverse_iterator(begin());}
152    _LIBCPP_INLINE_VISIBILITY const_reverse_iterator rend() const   {return const_reverse_iterator(begin());}
153
154    _LIBCPP_INLINE_VISIBILITY const_iterator cbegin() const          {return begin();}
155    _LIBCPP_INLINE_VISIBILITY const_iterator cend() const            {return end();}
156    _LIBCPP_INLINE_VISIBILITY const_reverse_iterator crbegin() const {return rbegin();}
157    _LIBCPP_INLINE_VISIBILITY const_reverse_iterator crend() const   {return rend();}
158
159    // capacity:
160    _LIBCPP_INLINE_VISIBILITY /*constexpr*/ size_type size() const      {return _Size;}
161    _LIBCPP_INLINE_VISIBILITY /*constexpr*/ size_type max_size() const  {return _Size;}
162    _LIBCPP_INLINE_VISIBILITY bool empty() const                    {return _Size == 0;}
163
164    // element access:
165    _LIBCPP_INLINE_VISIBILITY reference operator[](size_type __n)             {return __elems_[__n];}
166    _LIBCPP_INLINE_VISIBILITY const_reference operator[](size_type __n) const {return __elems_[__n];}
167    reference at(size_type __n);
168    const_reference at(size_type __n) const;
169
170    _LIBCPP_INLINE_VISIBILITY reference front()             {return __elems_[0];}
171    _LIBCPP_INLINE_VISIBILITY const_reference front() const {return __elems_[0];}
172    _LIBCPP_INLINE_VISIBILITY reference back()              {return __elems_[_Size > 0 ? _Size-1 : 0];}
173    _LIBCPP_INLINE_VISIBILITY const_reference back() const  {return __elems_[_Size > 0 ? _Size-1 : 0];}
174
175    _LIBCPP_INLINE_VISIBILITY value_type* data()             {return __elems_;}
176    _LIBCPP_INLINE_VISIBILITY const value_type* data() const {return __elems_;}
177};
178
179template <class _Tp, size_t _Size>
180typename array<_Tp, _Size>::reference
181array<_Tp, _Size>::at(size_type __n)
182{
183    if (__n >= _Size)
184#ifndef _LIBCPP_NO_EXCEPTIONS
185        throw out_of_range("array::at");
186#else
187        assert(!"array::at out_of_range");
188#endif
189    return __elems_[__n];
190}
191
192template <class _Tp, size_t _Size>
193typename array<_Tp, _Size>::const_reference
194array<_Tp, _Size>::at(size_type __n) const
195{
196    if (__n >= _Size)
197#ifndef _LIBCPP_NO_EXCEPTIONS
198        throw out_of_range("array::at");
199#else
200        assert(!"array::at out_of_range");
201#endif
202    return __elems_[__n];
203}
204
205template <class _Tp, size_t _Size>
206_LIBCPP_INLINE_VISIBILITY inline
207bool
208operator==(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
209{
210    return _STD::equal(__x.__elems_, __x.__elems_ + _Size, __y.__elems_);
211}
212
213template <class _Tp, size_t _Size>
214_LIBCPP_INLINE_VISIBILITY inline
215bool
216operator!=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
217{
218    return !(__x == __y);
219}
220
221template <class _Tp, size_t _Size>
222_LIBCPP_INLINE_VISIBILITY inline
223bool
224operator<(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
225{
226    return _STD::lexicographical_compare(__x.__elems_, __x.__elems_ + _Size, __y.__elems_, __y.__elems_ + _Size);
227}
228
229template <class _Tp, size_t _Size>
230_LIBCPP_INLINE_VISIBILITY inline
231bool
232operator>(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
233{
234    return __y < __x;
235}
236
237template <class _Tp, size_t _Size>
238_LIBCPP_INLINE_VISIBILITY inline
239bool
240operator<=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
241{
242    return !(__y < __x);
243}
244
245template <class _Tp, size_t _Size>
246_LIBCPP_INLINE_VISIBILITY inline
247bool
248operator>=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
249{
250    return !(__x < __y);
251}
252
253template <class _Tp, size_t _Size>
254_LIBCPP_INLINE_VISIBILITY inline
255void
256swap(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
257{
258    __x.swap(__y);
259}
260
261template <class _Tp, size_t _Size>
262class _LIBCPP_VISIBLE tuple_size<array<_Tp, _Size> >
263    : public integral_constant<size_t, _Size> {};
264
265template <class _Tp, size_t _Size>
266class _LIBCPP_VISIBLE tuple_size<const array<_Tp, _Size> >
267    : public integral_constant<size_t, _Size> {};
268
269template <size_t _Ip, class _Tp, size_t _Size>
270class _LIBCPP_VISIBLE tuple_element<_Ip, array<_Tp, _Size> >
271{
272public:
273    typedef _Tp type;
274};
275
276template <size_t _Ip, class _Tp, size_t _Size>
277class _LIBCPP_VISIBLE tuple_element<_Ip, const array<_Tp, _Size> >
278{
279public:
280    typedef const _Tp type;
281};
282
283template <size_t _Ip, class _Tp, size_t _Size>
284_LIBCPP_INLINE_VISIBILITY inline
285_Tp&
286get(array<_Tp, _Size>& __a)
287{
288    return __a[_Ip];
289}
290
291template <size_t _Ip, class _Tp, size_t _Size>
292_LIBCPP_INLINE_VISIBILITY inline
293const _Tp&
294get(const array<_Tp, _Size>& __a)
295{
296    return __a[_Ip];
297}
298
299#ifndef _LIBCPP_HAS_NO_RVALUE_REFERENCES
300
301template <size_t _Ip, class _Tp, size_t _Size>
302_LIBCPP_INLINE_VISIBILITY inline
303_Tp&&
304get(array<_Tp, _Size>&& __a)
305{
306    return _STD::move(__a[_Ip]);
307}
308
309#endif  // _LIBCPP_HAS_NO_RVALUE_REFERENCES
310
311_LIBCPP_END_NAMESPACE_STD
312
313#endif  // _LIBCPP_ARRAY
314