xref: /freebsd/contrib/llvm-project/libcxx/include/array (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
10b57cec5SDimitry Andric// -*- C++ -*-
2349cc55cSDimitry Andric//===----------------------------------------------------------------------===//
30b57cec5SDimitry Andric//
40b57cec5SDimitry Andric// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
50b57cec5SDimitry Andric// See https://llvm.org/LICENSE.txt for license information.
60b57cec5SDimitry Andric// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
70b57cec5SDimitry Andric//
80b57cec5SDimitry Andric//===----------------------------------------------------------------------===//
90b57cec5SDimitry Andric
100b57cec5SDimitry Andric#ifndef _LIBCPP_ARRAY
110b57cec5SDimitry Andric#define _LIBCPP_ARRAY
120b57cec5SDimitry Andric
130b57cec5SDimitry Andric/*
140b57cec5SDimitry Andric    array synopsis
150b57cec5SDimitry Andric
160b57cec5SDimitry Andricnamespace std
170b57cec5SDimitry Andric{
180b57cec5SDimitry Andrictemplate <class T, size_t N >
190b57cec5SDimitry Andricstruct array
200b57cec5SDimitry Andric{
210b57cec5SDimitry Andric    // types:
220b57cec5SDimitry Andric    typedef T & reference;
230b57cec5SDimitry Andric    typedef const T & const_reference;
240b57cec5SDimitry Andric    typedef implementation defined iterator;
250b57cec5SDimitry Andric    typedef implementation defined const_iterator;
260b57cec5SDimitry Andric    typedef size_t size_type;
270b57cec5SDimitry Andric    typedef ptrdiff_t difference_type;
280b57cec5SDimitry Andric    typedef T value_type;
290b57cec5SDimitry Andric    typedef T* pointer;
300b57cec5SDimitry Andric    typedef const T* const_pointer;
310b57cec5SDimitry Andric    typedef std::reverse_iterator<iterator> reverse_iterator;
320b57cec5SDimitry Andric    typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
330b57cec5SDimitry Andric
340b57cec5SDimitry Andric    // No explicit construct/copy/destroy for aggregate type
355ffd83dbSDimitry Andric    void fill(const T& u);                                      // constexpr in C++20
365ffd83dbSDimitry Andric    void swap(array& a) noexcept(is_nothrow_swappable_v<T>);    // constexpr in C++20
370b57cec5SDimitry Andric
380b57cec5SDimitry Andric    // iterators:
395ffd83dbSDimitry Andric    iterator begin() noexcept;                                  // constexpr in C++17
405ffd83dbSDimitry Andric    const_iterator begin() const noexcept;                      // constexpr in C++17
415ffd83dbSDimitry Andric    iterator end() noexcept;                                    // constexpr in C++17
425ffd83dbSDimitry Andric    const_iterator end() const noexcept;                        // constexpr in C++17
430b57cec5SDimitry Andric
445ffd83dbSDimitry Andric    reverse_iterator rbegin() noexcept;                         // constexpr in C++17
455ffd83dbSDimitry Andric    const_reverse_iterator rbegin() const noexcept;             // constexpr in C++17
465ffd83dbSDimitry Andric    reverse_iterator rend() noexcept;                           // constexpr in C++17
475ffd83dbSDimitry Andric    const_reverse_iterator rend() const noexcept;               // constexpr in C++17
480b57cec5SDimitry Andric
495ffd83dbSDimitry Andric    const_iterator cbegin() const noexcept;                     // constexpr in C++17
505ffd83dbSDimitry Andric    const_iterator cend() const noexcept;                       // constexpr in C++17
515ffd83dbSDimitry Andric    const_reverse_iterator crbegin() const noexcept;            // constexpr in C++17
525ffd83dbSDimitry Andric    const_reverse_iterator crend() const noexcept;              // constexpr in C++17
530b57cec5SDimitry Andric
540b57cec5SDimitry Andric    // capacity:
550b57cec5SDimitry Andric    constexpr size_type size() const noexcept;
560b57cec5SDimitry Andric    constexpr size_type max_size() const noexcept;
570b57cec5SDimitry Andric    constexpr bool empty() const noexcept;
580b57cec5SDimitry Andric
590b57cec5SDimitry Andric    // element access:
605ffd83dbSDimitry Andric    reference operator[](size_type n);                          // constexpr in C++17
610b57cec5SDimitry Andric    const_reference operator[](size_type n) const;              // constexpr in C++14
625ffd83dbSDimitry Andric    reference at(size_type n);                                  // constexpr in C++17
630b57cec5SDimitry Andric    const_reference at(size_type n) const;                      // constexpr in C++14
640b57cec5SDimitry Andric
655ffd83dbSDimitry Andric    reference front();                                          // constexpr in C++17
660b57cec5SDimitry Andric    const_reference front() const;                              // constexpr in C++14
675ffd83dbSDimitry Andric    reference back();                                           // constexpr in C++17
680b57cec5SDimitry Andric    const_reference back() const;                               // constexpr in C++14
690b57cec5SDimitry Andric
705ffd83dbSDimitry Andric    T* data() noexcept;                                         // constexpr in C++17
715ffd83dbSDimitry Andric    const T* data() const noexcept;                             // constexpr in C++17
720b57cec5SDimitry Andric};
730b57cec5SDimitry Andric
740b57cec5SDimitry Andrictemplate <class T, class... U>
755ffd83dbSDimitry Andric  array(T, U...) -> array<T, 1 + sizeof...(U)>;                 // C++17
760b57cec5SDimitry Andric
770b57cec5SDimitry Andrictemplate <class T, size_t N>
785ffd83dbSDimitry Andric  bool operator==(const array<T,N>& x, const array<T,N>& y);    // constexpr in C++20
790b57cec5SDimitry Andrictemplate <class T, size_t N>
80*06c3fb27SDimitry Andric  bool operator!=(const array<T,N>& x, const array<T,N>& y);    // removed in C++20
810b57cec5SDimitry Andrictemplate <class T, size_t N>
82*06c3fb27SDimitry Andric  bool operator<(const array<T,N>& x, const array<T,N>& y);     // removed in C++20
830b57cec5SDimitry Andrictemplate <class T, size_t N>
84*06c3fb27SDimitry Andric  bool operator>(const array<T,N>& x, const array<T,N>& y);     // removed in C++20
850b57cec5SDimitry Andrictemplate <class T, size_t N>
86*06c3fb27SDimitry Andric  bool operator<=(const array<T,N>& x, const array<T,N>& y);    // removed in C++20
870b57cec5SDimitry Andrictemplate <class T, size_t N>
88*06c3fb27SDimitry Andric  bool operator>=(const array<T,N>& x, const array<T,N>& y);    // removed in C++20
89*06c3fb27SDimitry Andrictemplate<class T, size_t N>
90*06c3fb27SDimitry Andric  constexpr synth-three-way-result<T>
91*06c3fb27SDimitry Andric    operator<=>(const array<T, N>& x, const array<T, N>& y);    // since C++20
920b57cec5SDimitry Andric
930b57cec5SDimitry Andrictemplate <class T, size_t N >
945ffd83dbSDimitry Andric  void swap(array<T,N>& x, array<T,N>& y) noexcept(noexcept(x.swap(y))); // constexpr in C++20
955ffd83dbSDimitry Andric
965ffd83dbSDimitry Andrictemplate <class T, size_t N>
975ffd83dbSDimitry Andric  constexpr array<remove_cv_t<T>, N> to_array(T (&a)[N]);  // C++20
985ffd83dbSDimitry Andrictemplate <class T, size_t N>
995ffd83dbSDimitry Andric  constexpr array<remove_cv_t<T>, N> to_array(T (&&a)[N]); // C++20
1000b57cec5SDimitry Andric
1010b57cec5SDimitry Andrictemplate <class T> struct tuple_size;
1020b57cec5SDimitry Andrictemplate <size_t I, class T> struct tuple_element;
1030b57cec5SDimitry Andrictemplate <class T, size_t N> struct tuple_size<array<T, N>>;
1040b57cec5SDimitry Andrictemplate <size_t I, class T, size_t N> struct tuple_element<I, array<T, N>>;
1050b57cec5SDimitry Andrictemplate <size_t I, class T, size_t N> T& get(array<T, N>&) noexcept;               // constexpr in C++14
1060b57cec5SDimitry Andrictemplate <size_t I, class T, size_t N> const T& get(const array<T, N>&) noexcept;   // constexpr in C++14
1070b57cec5SDimitry Andrictemplate <size_t I, class T, size_t N> T&& get(array<T, N>&&) noexcept;             // constexpr in C++14
1080b57cec5SDimitry Andrictemplate <size_t I, class T, size_t N> const T&& get(const array<T, N>&&) noexcept; // constexpr in C++14
1090b57cec5SDimitry Andric
1100b57cec5SDimitry Andric}  // std
1110b57cec5SDimitry Andric
1120b57cec5SDimitry Andric*/
1130b57cec5SDimitry Andric
11481ad6265SDimitry Andric#include <__algorithm/equal.h>
11581ad6265SDimitry Andric#include <__algorithm/fill_n.h>
11681ad6265SDimitry Andric#include <__algorithm/lexicographical_compare.h>
117*06c3fb27SDimitry Andric#include <__algorithm/lexicographical_compare_three_way.h>
11881ad6265SDimitry Andric#include <__algorithm/swap_ranges.h>
11981ad6265SDimitry Andric#include <__assert> // all public C++ headers provide the assertion handler
1200b57cec5SDimitry Andric#include <__config>
121*06c3fb27SDimitry Andric#include <__fwd/array.h>
12281ad6265SDimitry Andric#include <__iterator/reverse_iterator.h>
123*06c3fb27SDimitry Andric#include <__tuple/sfinae_helpers.h>
124*06c3fb27SDimitry Andric#include <__type_traits/conditional.h>
125*06c3fb27SDimitry Andric#include <__type_traits/is_array.h>
126*06c3fb27SDimitry Andric#include <__type_traits/is_const.h>
127*06c3fb27SDimitry Andric#include <__type_traits/is_constructible.h>
128*06c3fb27SDimitry Andric#include <__type_traits/is_move_constructible.h>
129*06c3fb27SDimitry Andric#include <__type_traits/is_nothrow_constructible.h>
130*06c3fb27SDimitry Andric#include <__type_traits/is_nothrow_move_constructible.h>
131*06c3fb27SDimitry Andric#include <__type_traits/is_same.h>
132*06c3fb27SDimitry Andric#include <__type_traits/is_swappable.h>
133*06c3fb27SDimitry Andric#include <__type_traits/remove_cv.h>
13481ad6265SDimitry Andric#include <__utility/integer_sequence.h>
13581ad6265SDimitry Andric#include <__utility/move.h>
13681ad6265SDimitry Andric#include <__utility/unreachable.h>
137fe6060f1SDimitry Andric#include <stdexcept>
1380b57cec5SDimitry Andric#include <version>
1390b57cec5SDimitry Andric
14081ad6265SDimitry Andric// standard-mandated includes
14181ad6265SDimitry Andric
14281ad6265SDimitry Andric// [iterator.range]
14381ad6265SDimitry Andric#include <__iterator/access.h>
14481ad6265SDimitry Andric#include <__iterator/data.h>
14581ad6265SDimitry Andric#include <__iterator/empty.h>
14681ad6265SDimitry Andric#include <__iterator/reverse_access.h>
14781ad6265SDimitry Andric#include <__iterator/size.h>
14881ad6265SDimitry Andric
14981ad6265SDimitry Andric// [array.syn]
15081ad6265SDimitry Andric#include <compare>
15181ad6265SDimitry Andric#include <initializer_list>
15281ad6265SDimitry Andric
153bdd1243dSDimitry Andric// [tuple.helper]
154*06c3fb27SDimitry Andric#include <__tuple/tuple_element.h>
155*06c3fb27SDimitry Andric#include <__tuple/tuple_size.h>
156bdd1243dSDimitry Andric
1570b57cec5SDimitry Andric#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
1580b57cec5SDimitry Andric#  pragma GCC system_header
1590b57cec5SDimitry Andric#endif
1600b57cec5SDimitry Andric
1610b57cec5SDimitry Andric_LIBCPP_BEGIN_NAMESPACE_STD
1620b57cec5SDimitry Andric
1630b57cec5SDimitry Andrictemplate <class _Tp, size_t _Size>
1640b57cec5SDimitry Andricstruct _LIBCPP_TEMPLATE_VIS array
1650b57cec5SDimitry Andric{
1660b57cec5SDimitry Andric    // types:
1670b57cec5SDimitry Andric    typedef array __self;
1680b57cec5SDimitry Andric    typedef _Tp                                   value_type;
1690b57cec5SDimitry Andric    typedef value_type&                           reference;
1700b57cec5SDimitry Andric    typedef const value_type&                     const_reference;
1710b57cec5SDimitry Andric    typedef value_type*                           iterator;
1720b57cec5SDimitry Andric    typedef const value_type*                     const_iterator;
1730b57cec5SDimitry Andric    typedef value_type*                           pointer;
1740b57cec5SDimitry Andric    typedef const value_type*                     const_pointer;
1750b57cec5SDimitry Andric    typedef size_t                                size_type;
1760b57cec5SDimitry Andric    typedef ptrdiff_t                             difference_type;
177e8d8bef9SDimitry Andric    typedef _VSTD::reverse_iterator<iterator>       reverse_iterator;
178e8d8bef9SDimitry Andric    typedef _VSTD::reverse_iterator<const_iterator> const_reverse_iterator;
1790b57cec5SDimitry Andric
1800b57cec5SDimitry Andric    _Tp __elems_[_Size];
1810b57cec5SDimitry Andric
1820b57cec5SDimitry Andric    // No explicit construct/copy/destroy for aggregate type
183bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX20
1845ffd83dbSDimitry Andric    void fill(const value_type& __u) {
1855ffd83dbSDimitry Andric        _VSTD::fill_n(data(), _Size, __u);
1860b57cec5SDimitry Andric    }
1870b57cec5SDimitry Andric
188bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX20
1890b57cec5SDimitry Andric    void swap(array& __a) _NOEXCEPT_(__is_nothrow_swappable<_Tp>::value) {
190e8d8bef9SDimitry Andric        _VSTD::swap_ranges(data(), data() + _Size, __a.data());
1910b57cec5SDimitry Andric    }
1920b57cec5SDimitry Andric
1930b57cec5SDimitry Andric    // iterators:
194bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
1950b57cec5SDimitry Andric    iterator begin() _NOEXCEPT {return iterator(data());}
196bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
1970b57cec5SDimitry Andric    const_iterator begin() const _NOEXCEPT {return const_iterator(data());}
198bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
1990b57cec5SDimitry Andric    iterator end() _NOEXCEPT {return iterator(data() + _Size);}
200bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2010b57cec5SDimitry Andric    const_iterator end() const _NOEXCEPT {return const_iterator(data() + _Size);}
2020b57cec5SDimitry Andric
203bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2040b57cec5SDimitry Andric    reverse_iterator rbegin() _NOEXCEPT {return reverse_iterator(end());}
205bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2060b57cec5SDimitry Andric    const_reverse_iterator rbegin() const _NOEXCEPT {return const_reverse_iterator(end());}
207bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2080b57cec5SDimitry Andric    reverse_iterator rend() _NOEXCEPT {return reverse_iterator(begin());}
209bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2100b57cec5SDimitry Andric    const_reverse_iterator rend() const _NOEXCEPT {return const_reverse_iterator(begin());}
2110b57cec5SDimitry Andric
212bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2130b57cec5SDimitry Andric    const_iterator cbegin() const _NOEXCEPT {return begin();}
214bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2150b57cec5SDimitry Andric    const_iterator cend() const _NOEXCEPT {return end();}
216bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2170b57cec5SDimitry Andric    const_reverse_iterator crbegin() const _NOEXCEPT {return rbegin();}
218bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2190b57cec5SDimitry Andric    const_reverse_iterator crend() const _NOEXCEPT {return rend();}
2200b57cec5SDimitry Andric
2210b57cec5SDimitry Andric    // capacity:
2220b57cec5SDimitry Andric    _LIBCPP_INLINE_VISIBILITY
2230b57cec5SDimitry Andric    _LIBCPP_CONSTEXPR size_type size() const _NOEXCEPT {return _Size;}
2240b57cec5SDimitry Andric    _LIBCPP_INLINE_VISIBILITY
2250b57cec5SDimitry Andric    _LIBCPP_CONSTEXPR size_type max_size() const _NOEXCEPT {return _Size;}
2260b57cec5SDimitry Andric    _LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_INLINE_VISIBILITY
2275ffd83dbSDimitry Andric    _LIBCPP_CONSTEXPR bool empty() const _NOEXCEPT {return _Size == 0;}
2280b57cec5SDimitry Andric
2290b57cec5SDimitry Andric    // element access:
230bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2315ffd83dbSDimitry Andric    reference operator[](size_type __n) _NOEXCEPT {
232*06c3fb27SDimitry Andric        _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(__n < _Size, "out-of-bounds access in std::array<T, N>");
2335ffd83dbSDimitry Andric        return __elems_[__n];
2345ffd83dbSDimitry Andric    }
235bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX14
2365ffd83dbSDimitry Andric    const_reference operator[](size_type __n) const _NOEXCEPT {
237*06c3fb27SDimitry Andric        _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(__n < _Size, "out-of-bounds access in std::array<T, N>");
2385ffd83dbSDimitry Andric        return __elems_[__n];
2395ffd83dbSDimitry Andric    }
2400b57cec5SDimitry Andric
241*06c3fb27SDimitry Andric    _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR_SINCE_CXX17 reference at(size_type __n)
2425ffd83dbSDimitry Andric    {
2435ffd83dbSDimitry Andric        if (__n >= _Size)
2445ffd83dbSDimitry Andric            __throw_out_of_range("array::at");
2455ffd83dbSDimitry Andric        return __elems_[__n];
2465ffd83dbSDimitry Andric    }
2470b57cec5SDimitry Andric
248*06c3fb27SDimitry Andric    _LIBCPP_HIDE_FROM_ABI _LIBCPP_CONSTEXPR_SINCE_CXX14 const_reference at(size_type __n) const
2495ffd83dbSDimitry Andric    {
2505ffd83dbSDimitry Andric        if (__n >= _Size)
2515ffd83dbSDimitry Andric            __throw_out_of_range("array::at");
2525ffd83dbSDimitry Andric        return __elems_[__n];
2535ffd83dbSDimitry Andric    }
2545ffd83dbSDimitry Andric
255bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17 reference front()             _NOEXCEPT {return (*this)[0];}
256bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX14 const_reference front() const _NOEXCEPT {return (*this)[0];}
257bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17 reference back()              _NOEXCEPT {return (*this)[_Size - 1];}
258bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX14 const_reference back() const  _NOEXCEPT {return (*this)[_Size - 1];}
2590b57cec5SDimitry Andric
260bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2610b57cec5SDimitry Andric    value_type* data() _NOEXCEPT {return __elems_;}
262bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2630b57cec5SDimitry Andric    const value_type* data() const _NOEXCEPT {return __elems_;}
2640b57cec5SDimitry Andric};
2650b57cec5SDimitry Andric
2660b57cec5SDimitry Andrictemplate <class _Tp>
2670b57cec5SDimitry Andricstruct _LIBCPP_TEMPLATE_VIS array<_Tp, 0>
2680b57cec5SDimitry Andric{
2690b57cec5SDimitry Andric    // types:
2700b57cec5SDimitry Andric    typedef array __self;
2710b57cec5SDimitry Andric    typedef _Tp                                   value_type;
2720b57cec5SDimitry Andric    typedef value_type&                           reference;
2730b57cec5SDimitry Andric    typedef const value_type&                     const_reference;
2740b57cec5SDimitry Andric    typedef value_type*                           iterator;
2750b57cec5SDimitry Andric    typedef const value_type*                     const_iterator;
2760b57cec5SDimitry Andric    typedef value_type*                           pointer;
2770b57cec5SDimitry Andric    typedef const value_type*                     const_pointer;
2780b57cec5SDimitry Andric    typedef size_t                                size_type;
2790b57cec5SDimitry Andric    typedef ptrdiff_t                             difference_type;
280e8d8bef9SDimitry Andric    typedef _VSTD::reverse_iterator<iterator>       reverse_iterator;
281e8d8bef9SDimitry Andric    typedef _VSTD::reverse_iterator<const_iterator> const_reverse_iterator;
2820b57cec5SDimitry Andric
283bdd1243dSDimitry Andric    typedef __conditional_t<is_const<_Tp>::value, const char, char> _CharType;
2840b57cec5SDimitry Andric
2850b57cec5SDimitry Andric    struct  _ArrayInStructT { _Tp __data_[1]; };
2860b57cec5SDimitry Andric    _ALIGNAS_TYPE(_ArrayInStructT) _CharType __elems_[sizeof(_ArrayInStructT)];
2870b57cec5SDimitry Andric
288bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2895ffd83dbSDimitry Andric    value_type* data() _NOEXCEPT {return nullptr;}
290bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
2915ffd83dbSDimitry Andric    const value_type* data() const _NOEXCEPT {return nullptr;}
2925ffd83dbSDimitry Andric
2930b57cec5SDimitry Andric    // No explicit construct/copy/destroy for aggregate type
294bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX20
2955ffd83dbSDimitry Andric    void fill(const value_type&) {
2960b57cec5SDimitry Andric      static_assert(!is_const<_Tp>::value,
2970b57cec5SDimitry Andric                    "cannot fill zero-sized array of type 'const T'");
2980b57cec5SDimitry Andric    }
2990b57cec5SDimitry Andric
300bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX20
3010b57cec5SDimitry Andric    void swap(array&) _NOEXCEPT {
3020b57cec5SDimitry Andric      static_assert(!is_const<_Tp>::value,
3030b57cec5SDimitry Andric                    "cannot swap zero-sized array of type 'const T'");
3040b57cec5SDimitry Andric    }
3050b57cec5SDimitry Andric
3060b57cec5SDimitry Andric    // iterators:
307bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3080b57cec5SDimitry Andric    iterator begin() _NOEXCEPT {return iterator(data());}
309bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3100b57cec5SDimitry Andric    const_iterator begin() const _NOEXCEPT {return const_iterator(data());}
311bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3120b57cec5SDimitry Andric    iterator end() _NOEXCEPT {return iterator(data());}
313bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3140b57cec5SDimitry Andric    const_iterator end() const _NOEXCEPT {return const_iterator(data());}
3150b57cec5SDimitry Andric
316bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3170b57cec5SDimitry Andric    reverse_iterator rbegin() _NOEXCEPT {return reverse_iterator(end());}
318bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3190b57cec5SDimitry Andric    const_reverse_iterator rbegin() const _NOEXCEPT {return const_reverse_iterator(end());}
320bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3210b57cec5SDimitry Andric    reverse_iterator rend() _NOEXCEPT {return reverse_iterator(begin());}
322bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3230b57cec5SDimitry Andric    const_reverse_iterator rend() const _NOEXCEPT {return const_reverse_iterator(begin());}
3240b57cec5SDimitry Andric
325bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3260b57cec5SDimitry Andric    const_iterator cbegin() const _NOEXCEPT {return begin();}
327bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3280b57cec5SDimitry Andric    const_iterator cend() const _NOEXCEPT {return end();}
329bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3300b57cec5SDimitry Andric    const_reverse_iterator crbegin() const _NOEXCEPT {return rbegin();}
331bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3320b57cec5SDimitry Andric    const_reverse_iterator crend() const _NOEXCEPT {return rend();}
3330b57cec5SDimitry Andric
3340b57cec5SDimitry Andric    // capacity:
3350b57cec5SDimitry Andric    _LIBCPP_INLINE_VISIBILITY
3360b57cec5SDimitry Andric    _LIBCPP_CONSTEXPR size_type size() const _NOEXCEPT {return 0; }
3370b57cec5SDimitry Andric    _LIBCPP_INLINE_VISIBILITY
3380b57cec5SDimitry Andric    _LIBCPP_CONSTEXPR size_type max_size() const _NOEXCEPT {return 0;}
3390b57cec5SDimitry Andric    _LIBCPP_NODISCARD_AFTER_CXX17 _LIBCPP_INLINE_VISIBILITY
3400b57cec5SDimitry Andric    _LIBCPP_CONSTEXPR bool empty() const _NOEXCEPT {return true;}
3410b57cec5SDimitry Andric
3420b57cec5SDimitry Andric    // element access:
343bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3440b57cec5SDimitry Andric    reference operator[](size_type) _NOEXCEPT {
345*06c3fb27SDimitry Andric      _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(false, "cannot call array<T, 0>::operator[] on a zero-sized array");
34681ad6265SDimitry Andric      __libcpp_unreachable();
3470b57cec5SDimitry Andric    }
3480b57cec5SDimitry Andric
349bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX14
3500b57cec5SDimitry Andric    const_reference operator[](size_type) const _NOEXCEPT {
351*06c3fb27SDimitry Andric      _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(false, "cannot call array<T, 0>::operator[] on a zero-sized array");
35281ad6265SDimitry Andric      __libcpp_unreachable();
3530b57cec5SDimitry Andric    }
3540b57cec5SDimitry Andric
355bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3560b57cec5SDimitry Andric    reference at(size_type) {
3570b57cec5SDimitry Andric      __throw_out_of_range("array<T, 0>::at");
35881ad6265SDimitry Andric      __libcpp_unreachable();
3590b57cec5SDimitry Andric    }
3600b57cec5SDimitry Andric
361bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX14
3620b57cec5SDimitry Andric    const_reference at(size_type) const {
3630b57cec5SDimitry Andric      __throw_out_of_range("array<T, 0>::at");
36481ad6265SDimitry Andric      __libcpp_unreachable();
3650b57cec5SDimitry Andric    }
3660b57cec5SDimitry Andric
367bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3680b57cec5SDimitry Andric    reference front() _NOEXCEPT {
369*06c3fb27SDimitry Andric      _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(false, "cannot call array<T, 0>::front() on a zero-sized array");
37081ad6265SDimitry Andric      __libcpp_unreachable();
3710b57cec5SDimitry Andric    }
3720b57cec5SDimitry Andric
373bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX14
3740b57cec5SDimitry Andric    const_reference front() const _NOEXCEPT {
375*06c3fb27SDimitry Andric      _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(false, "cannot call array<T, 0>::front() on a zero-sized array");
37681ad6265SDimitry Andric      __libcpp_unreachable();
3770b57cec5SDimitry Andric    }
3780b57cec5SDimitry Andric
379bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX17
3800b57cec5SDimitry Andric    reference back() _NOEXCEPT {
381*06c3fb27SDimitry Andric      _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(false, "cannot call array<T, 0>::back() on a zero-sized array");
38281ad6265SDimitry Andric      __libcpp_unreachable();
3830b57cec5SDimitry Andric    }
3840b57cec5SDimitry Andric
385bdd1243dSDimitry Andric    _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX14
3860b57cec5SDimitry Andric    const_reference back() const _NOEXCEPT {
387*06c3fb27SDimitry Andric      _LIBCPP_ASSERT_VALID_ELEMENT_ACCESS(false, "cannot call array<T, 0>::back() on a zero-sized array");
38881ad6265SDimitry Andric      __libcpp_unreachable();
3890b57cec5SDimitry Andric    }
3900b57cec5SDimitry Andric};
3910b57cec5SDimitry Andric
3920b57cec5SDimitry Andric
393*06c3fb27SDimitry Andric#if _LIBCPP_STD_VER >= 17
3940b57cec5SDimitry Andrictemplate<class _Tp, class... _Args,
395349cc55cSDimitry Andric         class = enable_if_t<__all<_IsSame<_Tp, _Args>::value...>::value>
3960b57cec5SDimitry Andric         >
3970b57cec5SDimitry Andricarray(_Tp, _Args...)
3980b57cec5SDimitry Andric  -> array<_Tp, 1 + sizeof...(_Args)>;
3990b57cec5SDimitry Andric#endif
4000b57cec5SDimitry Andric
4010b57cec5SDimitry Andrictemplate <class _Tp, size_t _Size>
4020b57cec5SDimitry Andricinline _LIBCPP_INLINE_VISIBILITY
403bdd1243dSDimitry Andric_LIBCPP_CONSTEXPR_SINCE_CXX20 bool
4040b57cec5SDimitry Andricoperator==(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y)
4050b57cec5SDimitry Andric{
4060b57cec5SDimitry Andric    return _VSTD::equal(__x.begin(), __x.end(), __y.begin());
4070b57cec5SDimitry Andric}
4080b57cec5SDimitry Andric
409*06c3fb27SDimitry Andric#if _LIBCPP_STD_VER <= 17
410*06c3fb27SDimitry Andric
4110b57cec5SDimitry Andrictemplate <class _Tp, size_t _Size>
412*06c3fb27SDimitry Andricinline _LIBCPP_HIDE_FROM_ABI bool operator!=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y) {
4130b57cec5SDimitry Andric    return !(__x == __y);
4140b57cec5SDimitry Andric}
4150b57cec5SDimitry Andric
4160b57cec5SDimitry Andrictemplate <class _Tp, size_t _Size>
417*06c3fb27SDimitry Andricinline _LIBCPP_HIDE_FROM_ABI bool operator<(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y) {
418*06c3fb27SDimitry Andric    return _VSTD::lexicographical_compare(__x.begin(), __x.end(), __y.begin(), __y.end());
4190b57cec5SDimitry Andric}
4200b57cec5SDimitry Andric
4210b57cec5SDimitry Andrictemplate <class _Tp, size_t _Size>
422*06c3fb27SDimitry Andricinline _LIBCPP_HIDE_FROM_ABI bool operator>(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y) {
4230b57cec5SDimitry Andric    return __y < __x;
4240b57cec5SDimitry Andric}
4250b57cec5SDimitry Andric
4260b57cec5SDimitry Andrictemplate <class _Tp, size_t _Size>
427*06c3fb27SDimitry Andricinline _LIBCPP_HIDE_FROM_ABI bool operator<=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y) {
4280b57cec5SDimitry Andric    return !(__y < __x);
4290b57cec5SDimitry Andric}
4300b57cec5SDimitry Andric
4310b57cec5SDimitry Andrictemplate <class _Tp, size_t _Size>
432*06c3fb27SDimitry Andricinline _LIBCPP_HIDE_FROM_ABI bool operator>=(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y) {
4330b57cec5SDimitry Andric    return !(__x < __y);
4340b57cec5SDimitry Andric}
4350b57cec5SDimitry Andric
436*06c3fb27SDimitry Andric#else // _LIBCPP_STD_VER <= 17
437*06c3fb27SDimitry Andric
438*06c3fb27SDimitry Andrictemplate <class _Tp, size_t _Size>
439*06c3fb27SDimitry Andric_LIBCPP_HIDE_FROM_ABI constexpr __synth_three_way_result<_Tp>
440*06c3fb27SDimitry Andricoperator<=>(const array<_Tp, _Size>& __x, const array<_Tp, _Size>& __y) {
441*06c3fb27SDimitry Andric    return std::lexicographical_compare_three_way(
442*06c3fb27SDimitry Andric        __x.begin(), __x.end(), __y.begin(), __y.end(), std::__synth_three_way<_Tp, _Tp>);
443*06c3fb27SDimitry Andric}
444*06c3fb27SDimitry Andric
445*06c3fb27SDimitry Andric#endif // _LIBCPP_STD_VER <= 17
446*06c3fb27SDimitry Andric
4470b57cec5SDimitry Andrictemplate <class _Tp, size_t _Size>
448bdd1243dSDimitry Andricinline _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX20
449753f127fSDimitry Andric__enable_if_t<_Size == 0 || __is_swappable<_Tp>::value, void>
4500b57cec5SDimitry Andricswap(array<_Tp, _Size>& __x, array<_Tp, _Size>& __y)
4510b57cec5SDimitry Andric                                  _NOEXCEPT_(noexcept(__x.swap(__y)))
4520b57cec5SDimitry Andric{
4530b57cec5SDimitry Andric    __x.swap(__y);
4540b57cec5SDimitry Andric}
4550b57cec5SDimitry Andric
4560b57cec5SDimitry Andrictemplate <class _Tp, size_t _Size>
4570b57cec5SDimitry Andricstruct _LIBCPP_TEMPLATE_VIS tuple_size<array<_Tp, _Size> >
4580b57cec5SDimitry Andric    : public integral_constant<size_t, _Size> {};
4590b57cec5SDimitry Andric
4600b57cec5SDimitry Andrictemplate <size_t _Ip, class _Tp, size_t _Size>
4610b57cec5SDimitry Andricstruct _LIBCPP_TEMPLATE_VIS tuple_element<_Ip, array<_Tp, _Size> >
4620b57cec5SDimitry Andric{
4630b57cec5SDimitry Andric    static_assert(_Ip < _Size, "Index out of bounds in std::tuple_element<> (std::array)");
4640b57cec5SDimitry Andric    typedef _Tp type;
4650b57cec5SDimitry Andric};
4660b57cec5SDimitry Andric
4670b57cec5SDimitry Andrictemplate <size_t _Ip, class _Tp, size_t _Size>
468bdd1243dSDimitry Andricinline _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX14
4690b57cec5SDimitry Andric_Tp&
4700b57cec5SDimitry Andricget(array<_Tp, _Size>& __a) _NOEXCEPT
4710b57cec5SDimitry Andric{
4720b57cec5SDimitry Andric    static_assert(_Ip < _Size, "Index out of bounds in std::get<> (std::array)");
4730b57cec5SDimitry Andric    return __a.__elems_[_Ip];
4740b57cec5SDimitry Andric}
4750b57cec5SDimitry Andric
4760b57cec5SDimitry Andrictemplate <size_t _Ip, class _Tp, size_t _Size>
477bdd1243dSDimitry Andricinline _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX14
4780b57cec5SDimitry Andricconst _Tp&
4790b57cec5SDimitry Andricget(const array<_Tp, _Size>& __a) _NOEXCEPT
4800b57cec5SDimitry Andric{
4810b57cec5SDimitry Andric    static_assert(_Ip < _Size, "Index out of bounds in std::get<> (const std::array)");
4820b57cec5SDimitry Andric    return __a.__elems_[_Ip];
4830b57cec5SDimitry Andric}
4840b57cec5SDimitry Andric
4850b57cec5SDimitry Andrictemplate <size_t _Ip, class _Tp, size_t _Size>
486bdd1243dSDimitry Andricinline _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX14
4870b57cec5SDimitry Andric_Tp&&
4880b57cec5SDimitry Andricget(array<_Tp, _Size>&& __a) _NOEXCEPT
4890b57cec5SDimitry Andric{
4900b57cec5SDimitry Andric    static_assert(_Ip < _Size, "Index out of bounds in std::get<> (std::array &&)");
4910b57cec5SDimitry Andric    return _VSTD::move(__a.__elems_[_Ip]);
4920b57cec5SDimitry Andric}
4930b57cec5SDimitry Andric
4940b57cec5SDimitry Andrictemplate <size_t _Ip, class _Tp, size_t _Size>
495bdd1243dSDimitry Andricinline _LIBCPP_INLINE_VISIBILITY _LIBCPP_CONSTEXPR_SINCE_CXX14
4960b57cec5SDimitry Andricconst _Tp&&
4970b57cec5SDimitry Andricget(const array<_Tp, _Size>&& __a) _NOEXCEPT
4980b57cec5SDimitry Andric{
4990b57cec5SDimitry Andric    static_assert(_Ip < _Size, "Index out of bounds in std::get<> (const std::array &&)");
5000b57cec5SDimitry Andric    return _VSTD::move(__a.__elems_[_Ip]);
5010b57cec5SDimitry Andric}
5020b57cec5SDimitry Andric
503*06c3fb27SDimitry Andric#if _LIBCPP_STD_VER >= 20
5045ffd83dbSDimitry Andric
5055ffd83dbSDimitry Andrictemplate <typename _Tp, size_t _Size, size_t... _Index>
5065ffd83dbSDimitry Andric_LIBCPP_INLINE_VISIBILITY constexpr array<remove_cv_t<_Tp>, _Size>
5075ffd83dbSDimitry Andric__to_array_lvalue_impl(_Tp (&__arr)[_Size], index_sequence<_Index...>) {
5085ffd83dbSDimitry Andric  return {{__arr[_Index]...}};
5095ffd83dbSDimitry Andric}
5105ffd83dbSDimitry Andric
5115ffd83dbSDimitry Andrictemplate <typename _Tp, size_t _Size, size_t... _Index>
5125ffd83dbSDimitry Andric_LIBCPP_INLINE_VISIBILITY constexpr array<remove_cv_t<_Tp>, _Size>
5135ffd83dbSDimitry Andric__to_array_rvalue_impl(_Tp(&&__arr)[_Size], index_sequence<_Index...>) {
5145ffd83dbSDimitry Andric  return {{_VSTD::move(__arr[_Index])...}};
5155ffd83dbSDimitry Andric}
5165ffd83dbSDimitry Andric
5175ffd83dbSDimitry Andrictemplate <typename _Tp, size_t _Size>
5185ffd83dbSDimitry Andric_LIBCPP_INLINE_VISIBILITY constexpr array<remove_cv_t<_Tp>, _Size>
5195ffd83dbSDimitry Andricto_array(_Tp (&__arr)[_Size]) noexcept(is_nothrow_constructible_v<_Tp, _Tp&>) {
5205ffd83dbSDimitry Andric  static_assert(
5215ffd83dbSDimitry Andric      !is_array_v<_Tp>,
5225ffd83dbSDimitry Andric      "[array.creation]/1: to_array does not accept multidimensional arrays.");
5235ffd83dbSDimitry Andric  static_assert(
5245ffd83dbSDimitry Andric      is_constructible_v<_Tp, _Tp&>,
5255ffd83dbSDimitry Andric      "[array.creation]/1: to_array requires copy constructible elements.");
526e8d8bef9SDimitry Andric  return _VSTD::__to_array_lvalue_impl(__arr, make_index_sequence<_Size>());
5275ffd83dbSDimitry Andric}
5285ffd83dbSDimitry Andric
5295ffd83dbSDimitry Andrictemplate <typename _Tp, size_t _Size>
5305ffd83dbSDimitry Andric_LIBCPP_INLINE_VISIBILITY constexpr array<remove_cv_t<_Tp>, _Size>
5315ffd83dbSDimitry Andricto_array(_Tp(&&__arr)[_Size]) noexcept(is_nothrow_move_constructible_v<_Tp>) {
5325ffd83dbSDimitry Andric  static_assert(
5335ffd83dbSDimitry Andric      !is_array_v<_Tp>,
5345ffd83dbSDimitry Andric      "[array.creation]/4: to_array does not accept multidimensional arrays.");
5355ffd83dbSDimitry Andric  static_assert(
5365ffd83dbSDimitry Andric      is_move_constructible_v<_Tp>,
5375ffd83dbSDimitry Andric      "[array.creation]/4: to_array requires move constructible elements.");
538e8d8bef9SDimitry Andric  return _VSTD::__to_array_rvalue_impl(_VSTD::move(__arr),
5395ffd83dbSDimitry Andric                                       make_index_sequence<_Size>());
5405ffd83dbSDimitry Andric}
5415ffd83dbSDimitry Andric
542*06c3fb27SDimitry Andric#endif // _LIBCPP_STD_VER >= 20
5435ffd83dbSDimitry Andric
5440b57cec5SDimitry Andric_LIBCPP_END_NAMESPACE_STD
5450b57cec5SDimitry Andric
546bdd1243dSDimitry Andric#if !defined(_LIBCPP_REMOVE_TRANSITIVE_INCLUDES) && _LIBCPP_STD_VER <= 20
547bdd1243dSDimitry Andric#  include <algorithm>
548bdd1243dSDimitry Andric#  include <concepts>
549*06c3fb27SDimitry Andric#  include <cstdlib>
550bdd1243dSDimitry Andric#  include <iterator>
551*06c3fb27SDimitry Andric#  include <type_traits>
552bdd1243dSDimitry Andric#  include <utility>
553bdd1243dSDimitry Andric#endif
554bdd1243dSDimitry Andric
5550b57cec5SDimitry Andric#endif // _LIBCPP_ARRAY
556