blob: 1fe1496530e983d85044ba2b15db2d1c0f2c5b24 [file] [log] [blame]
Marshall Clowd2ad87e2018-07-24 03:01:02 +00001// -*- C++ -*-
2//===------------------------------ span ---------------------------------===//
3//
Chandler Carruthd2012102019-01-19 10:56:40 +00004// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Marshall Clowd2ad87e2018-07-24 03:01:02 +00007//
8//===---------------------------------------------------------------------===//
9
10#ifndef _LIBCPP_SPAN
11#define _LIBCPP_SPAN
12
13/*
14 span synopsis
15
16namespace std {
17
18// constants
Marshall Clowcd6d8802019-02-27 00:32:16 +000019inline constexpr size_t dynamic_extent = numeric_limits<size_t>::max();
Marshall Clowd2ad87e2018-07-24 03:01:02 +000020
21// [views.span], class template span
Marshall Clowcd6d8802019-02-27 00:32:16 +000022template <class ElementType, size_t Extent = dynamic_extent>
Marshall Clowd2ad87e2018-07-24 03:01:02 +000023 class span;
24
Marshall Clowd2ad87e2018-07-24 03:01:02 +000025// [span.objectrep], views of object representation
Marshall Clowcd6d8802019-02-27 00:32:16 +000026template <class ElementType, size_t Extent>
Louis Dionne44bcff92018-08-03 22:36:53 +000027 span<const byte, ((Extent == dynamic_extent) ? dynamic_extent :
Marshall Clowe246c9f2019-03-06 03:59:44 +000028 (sizeof(ElementType) * Extent))> as_bytes(span<ElementType, Extent> s) noexcept;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000029
Marshall Clowcd6d8802019-02-27 00:32:16 +000030template <class ElementType, size_t Extent>
Louis Dionne44bcff92018-08-03 22:36:53 +000031 span< byte, ((Extent == dynamic_extent) ? dynamic_extent :
Marshall Clowe246c9f2019-03-06 03:59:44 +000032 (sizeof(ElementType) * Extent))> as_writable_bytes(span<ElementType, Extent> s) noexcept;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000033
34
35namespace std {
Marshall Clowcd6d8802019-02-27 00:32:16 +000036template <class ElementType, size_t Extent = dynamic_extent>
Marshall Clowd2ad87e2018-07-24 03:01:02 +000037class span {
38public:
39 // constants and types
40 using element_type = ElementType;
41 using value_type = remove_cv_t<ElementType>;
Louis Dionne7b89ab02019-11-14 09:07:05 -050042 using size_type = size_t;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000043 using difference_type = ptrdiff_t;
44 using pointer = element_type*;
Marshall Clow4b7f2c32019-02-25 17:58:03 +000045 using const_pointer = const element_type*;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000046 using reference = element_type&;
Marshall Clow4b7f2c32019-02-25 17:58:03 +000047 using const_reference = const element_type&;
Marshall Clowcd6d8802019-02-27 00:32:16 +000048 using iterator = implementation-defined;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000049 using const_iterator = implementation-defined;
50 using reverse_iterator = std::reverse_iterator<iterator>;
51 using const_reverse_iterator = std::reverse_iterator<const_iterator>;
Louis Dionne7b89ab02019-11-14 09:07:05 -050052 static constexpr size_type extent = Extent;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000053
54 // [span.cons], span constructors, copy, assignment, and destructor
55 constexpr span() noexcept;
Louis Dionne7b89ab02019-11-14 09:07:05 -050056 constexpr span(pointer ptr, size_type count);
Marshall Clowd2ad87e2018-07-24 03:01:02 +000057 constexpr span(pointer firstElem, pointer lastElem);
58 template <size_t N>
59 constexpr span(element_type (&arr)[N]) noexcept;
60 template <size_t N>
61 constexpr span(array<value_type, N>& arr) noexcept;
62 template <size_t N>
63 constexpr span(const array<value_type, N>& arr) noexcept;
64 template <class Container>
65 constexpr span(Container& cont);
66 template <class Container>
67 constexpr span(const Container& cont);
68 constexpr span(const span& other) noexcept = default;
Marshall Clowcd6d8802019-02-27 00:32:16 +000069 template <class OtherElementType, size_t OtherExtent>
Marshall Clowd2ad87e2018-07-24 03:01:02 +000070 constexpr span(const span<OtherElementType, OtherExtent>& s) noexcept;
71 ~span() noexcept = default;
72 constexpr span& operator=(const span& other) noexcept = default;
73
74 // [span.sub], span subviews
Marshall Clowcd6d8802019-02-27 00:32:16 +000075 template <size_t Count>
Marshall Clowd2ad87e2018-07-24 03:01:02 +000076 constexpr span<element_type, Count> first() const;
Marshall Clowcd6d8802019-02-27 00:32:16 +000077 template <size_t Count>
Marshall Clowd2ad87e2018-07-24 03:01:02 +000078 constexpr span<element_type, Count> last() const;
Marshall Clowcd6d8802019-02-27 00:32:16 +000079 template <size_t Offset, size_t Count = dynamic_extent>
Marshall Clowd2ad87e2018-07-24 03:01:02 +000080 constexpr span<element_type, see below> subspan() const;
81
Louis Dionne7b89ab02019-11-14 09:07:05 -050082 constexpr span<element_type, dynamic_extent> first(size_type count) const;
83 constexpr span<element_type, dynamic_extent> last(size_type count) const;
84 constexpr span<element_type, dynamic_extent> subspan(size_type offset, size_type count = dynamic_extent) const;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000085
86 // [span.obs], span observers
Louis Dionne7b89ab02019-11-14 09:07:05 -050087 constexpr size_type size() const noexcept;
88 constexpr size_type size_bytes() const noexcept;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000089 constexpr bool empty() const noexcept;
90
91 // [span.elem], span element access
Louis Dionne7b89ab02019-11-14 09:07:05 -050092 constexpr reference operator[](size_type idx) const;
Marshall Clow89408802019-02-25 17:54:08 +000093 constexpr reference front() const;
94 constexpr reference back() const;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000095 constexpr pointer data() const noexcept;
96
97 // [span.iterators], span iterator support
98 constexpr iterator begin() const noexcept;
99 constexpr iterator end() const noexcept;
100 constexpr const_iterator cbegin() const noexcept;
101 constexpr const_iterator cend() const noexcept;
102 constexpr reverse_iterator rbegin() const noexcept;
103 constexpr reverse_iterator rend() const noexcept;
104 constexpr const_reverse_iterator crbegin() const noexcept;
105 constexpr const_reverse_iterator crend() const noexcept;
106
107private:
Louis Dionne7b89ab02019-11-14 09:07:05 -0500108 pointer data_; // exposition only
109 size_type size_; // exposition only
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000110};
111
112template<class T, size_t N>
113 span(T (&)[N]) -> span<T, N>;
Louis Dionne44bcff92018-08-03 22:36:53 +0000114
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000115template<class T, size_t N>
116 span(array<T, N>&) -> span<T, N>;
117
118template<class T, size_t N>
119 span(const array<T, N>&) -> span<const T, N>;
120
121template<class Container>
122 span(Container&) -> span<typename Container::value_type>;
123
124template<class Container>
125 span(const Container&) -> span<const typename Container::value_type>;
126
127} // namespace std
128
129*/
130
Marshall Clow8dc3ea12018-07-24 03:56:38 +0000131#include <__config>
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000132#include <array> // for array
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000133#include <cstddef> // for byte
Louis Dionne533a14e2020-02-11 11:16:40 +0100134#include <iterator> // for iterators
135#include <type_traits> // for remove_cv, etc
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000136
137#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
138#pragma GCC system_header
139#endif
140
141_LIBCPP_BEGIN_NAMESPACE_STD
142
143#if _LIBCPP_STD_VER > 17
144
Louis Dionnecba47f72020-02-10 13:38:04 +0100145inline constexpr size_t dynamic_extent = (numeric_limits<size_t>::max)();
Marshall Clowcd6d8802019-02-27 00:32:16 +0000146template <typename _Tp, size_t _Extent = dynamic_extent> class span;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000147
148
149template <class _Tp>
150struct __is_span_impl : public false_type {};
151
Marshall Clowcd6d8802019-02-27 00:32:16 +0000152template <class _Tp, size_t _Extent>
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000153struct __is_span_impl<span<_Tp, _Extent>> : public true_type {};
154
155template <class _Tp>
156struct __is_span : public __is_span_impl<remove_cv_t<_Tp>> {};
157
158template <class _Tp>
159struct __is_std_array_impl : public false_type {};
160
161template <class _Tp, size_t _Sz>
162struct __is_std_array_impl<array<_Tp, _Sz>> : public true_type {};
163
164template <class _Tp>
165struct __is_std_array : public __is_std_array_impl<remove_cv_t<_Tp>> {};
166
167template <class _Tp, class _ElementType, class = void>
168struct __is_span_compatible_container : public false_type {};
169
170template <class _Tp, class _ElementType>
171struct __is_span_compatible_container<_Tp, _ElementType,
172 void_t<
173 // is not a specialization of span
174 typename enable_if<!__is_span<_Tp>::value, nullptr_t>::type,
175 // is not a specialization of array
176 typename enable_if<!__is_std_array<_Tp>::value, nullptr_t>::type,
177 // is_array_v<Container> is false,
178 typename enable_if<!is_array_v<_Tp>, nullptr_t>::type,
179 // data(cont) and size(cont) are well formed
180 decltype(data(declval<_Tp>())),
181 decltype(size(declval<_Tp>())),
182 // remove_pointer_t<decltype(data(cont))>(*)[] is convertible to ElementType(*)[]
183 typename enable_if<
Louis Dionne44bcff92018-08-03 22:36:53 +0000184 is_convertible_v<remove_pointer_t<decltype(data(declval<_Tp &>()))>(*)[],
185 _ElementType(*)[]>,
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000186 nullptr_t>::type
187 >>
188 : public true_type {};
189
190
Marshall Clowcd6d8802019-02-27 00:32:16 +0000191template <typename _Tp, size_t _Extent>
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000192class _LIBCPP_TEMPLATE_VIS span {
193public:
194// constants and types
195 using element_type = _Tp;
196 using value_type = remove_cv_t<_Tp>;
Louis Dionne7b89ab02019-11-14 09:07:05 -0500197 using size_type = size_t;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000198 using difference_type = ptrdiff_t;
199 using pointer = _Tp *;
Marshall Clow4b7f2c32019-02-25 17:58:03 +0000200 using const_pointer = const _Tp *;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000201 using reference = _Tp &;
Marshall Clow4b7f2c32019-02-25 17:58:03 +0000202 using const_reference = const _Tp &;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000203 using iterator = __wrap_iter<pointer>;
204 using const_iterator = __wrap_iter<const_pointer>;
205 using reverse_iterator = _VSTD::reverse_iterator<iterator>;
206 using const_reverse_iterator = _VSTD::reverse_iterator<const_iterator>;
207
Louis Dionne7b89ab02019-11-14 09:07:05 -0500208 static constexpr size_type extent = _Extent;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000209
Louis Dionne44bcff92018-08-03 22:36:53 +0000210// [span.cons], span constructors, copy, assignment, and destructor
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000211 _LIBCPP_INLINE_VISIBILITY constexpr span() noexcept : __data{nullptr}
212 { static_assert(_Extent == 0, "Can't default construct a statically sized span with size > 0"); }
213
214 constexpr span (const span&) noexcept = default;
215 constexpr span& operator=(const span&) noexcept = default;
216
Louis Dionne7b89ab02019-11-14 09:07:05 -0500217 _LIBCPP_INLINE_VISIBILITY constexpr span(pointer __ptr, size_type __count) : __data{__ptr}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000218 { (void)__count; _LIBCPP_ASSERT(_Extent == __count, "size mismatch in span's constructor (ptr, len)"); }
219 _LIBCPP_INLINE_VISIBILITY constexpr span(pointer __f, pointer __l) : __data{__f}
220 { (void)__l; _LIBCPP_ASSERT(_Extent == distance(__f, __l), "size mismatch in span's constructor (ptr, ptr)"); }
221
222 _LIBCPP_INLINE_VISIBILITY constexpr span(element_type (&__arr)[_Extent]) noexcept : __data{__arr} {}
223 _LIBCPP_INLINE_VISIBILITY constexpr span( array<value_type, _Extent>& __arr) noexcept : __data{__arr.data()} {}
224 _LIBCPP_INLINE_VISIBILITY constexpr span(const array<value_type, _Extent>& __arr) noexcept : __data{__arr.data()} {}
225
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000226 template <class _OtherElementType>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000227 _LIBCPP_INLINE_VISIBILITY
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000228 constexpr span(const span<_OtherElementType, _Extent>& __other,
229 enable_if_t<
230 is_convertible_v<_OtherElementType(*)[], element_type (*)[]>,
231 nullptr_t> = nullptr)
232 : __data{__other.data()} {}
233
234 template <class _OtherElementType>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000235 _LIBCPP_INLINE_VISIBILITY
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000236 constexpr span(const span<_OtherElementType, dynamic_extent>& __other,
237 enable_if_t<
238 is_convertible_v<_OtherElementType(*)[], element_type (*)[]>,
239 nullptr_t> = nullptr) noexcept
240 : __data{__other.data()} { _LIBCPP_ASSERT(_Extent == __other.size(), "size mismatch in span's constructor (other span)"); }
241
242
243// ~span() noexcept = default;
244
Marshall Clowcd6d8802019-02-27 00:32:16 +0000245 template <size_t _Count>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000246 _LIBCPP_INLINE_VISIBILITY
247 constexpr span<element_type, _Count> first() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000248 {
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000249 static_assert(_Count <= _Extent, "Count out of range in span::first()");
250 return {data(), _Count};
251 }
252
Marshall Clowcd6d8802019-02-27 00:32:16 +0000253 template <size_t _Count>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000254 _LIBCPP_INLINE_VISIBILITY
255 constexpr span<element_type, _Count> last() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000256 {
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000257 static_assert(_Count <= _Extent, "Count out of range in span::last()");
258 return {data() + size() - _Count, _Count};
259 }
Louis Dionne44bcff92018-08-03 22:36:53 +0000260
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000261 _LIBCPP_INLINE_VISIBILITY
Louis Dionne7b89ab02019-11-14 09:07:05 -0500262 constexpr span<element_type, dynamic_extent> first(size_type __count) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000263 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000264 _LIBCPP_ASSERT(__count <= size(), "Count out of range in span::first(count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000265 return {data(), __count};
266 }
267
268 _LIBCPP_INLINE_VISIBILITY
Louis Dionne7b89ab02019-11-14 09:07:05 -0500269 constexpr span<element_type, dynamic_extent> last(size_type __count) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000270 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000271 _LIBCPP_ASSERT(__count <= size(), "Count out of range in span::last(count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000272 return {data() + size() - __count, __count};
273 }
274
Marshall Clowcd6d8802019-02-27 00:32:16 +0000275 template <size_t _Offset, size_t _Count = dynamic_extent>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000276 _LIBCPP_INLINE_VISIBILITY
277 constexpr auto subspan() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000278 -> span<element_type, _Count != dynamic_extent ? _Count : _Extent - _Offset>
279 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000280 static_assert(_Offset <= _Extent, "Offset out of range in span::subspan()");
Louis Dionne45931e92020-02-12 16:20:09 +0100281 static_assert(_Count == dynamic_extent || _Count <= _Extent - _Offset, "Offset + count out of range in span::subspan()");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000282 return {data() + _Offset, _Count == dynamic_extent ? size() - _Offset : _Count};
283 }
284
285
Marshall Clowe246c9f2019-03-06 03:59:44 +0000286 _LIBCPP_INLINE_VISIBILITY
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000287 constexpr span<element_type, dynamic_extent>
Louis Dionne7b89ab02019-11-14 09:07:05 -0500288 subspan(size_type __offset, size_type __count = dynamic_extent) const noexcept
Louis Dionne44bcff92018-08-03 22:36:53 +0000289 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000290 _LIBCPP_ASSERT(__offset <= size(), "Offset out of range in span::subspan(offset, count)");
291 _LIBCPP_ASSERT(__count <= size() || __count == dynamic_extent, "Count out of range in span::subspan(offset, count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000292 if (__count == dynamic_extent)
293 return {data() + __offset, size() - __offset};
Louis Dionne45931e92020-02-12 16:20:09 +0100294 _LIBCPP_ASSERT(__count <= size() - __offset, "Offset + count out of range in span::subspan(offset, count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000295 return {data() + __offset, __count};
296 }
297
Louis Dionne7b89ab02019-11-14 09:07:05 -0500298 _LIBCPP_INLINE_VISIBILITY constexpr size_type size() const noexcept { return _Extent; }
299 _LIBCPP_INLINE_VISIBILITY constexpr size_type size_bytes() const noexcept { return _Extent * sizeof(element_type); }
300 _LIBCPP_INLINE_VISIBILITY constexpr bool empty() const noexcept { return _Extent == 0; }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000301
Louis Dionne7b89ab02019-11-14 09:07:05 -0500302 _LIBCPP_INLINE_VISIBILITY constexpr reference operator[](size_type __idx) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000303 {
Louis Dionne956eca82020-02-11 11:38:00 +0100304 _LIBCPP_ASSERT(__idx < size(), "span<T,N>[] index out of bounds");
Louis Dionne44bcff92018-08-03 22:36:53 +0000305 return __data[__idx];
306 }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000307
Marshall Clow89408802019-02-25 17:54:08 +0000308 _LIBCPP_INLINE_VISIBILITY constexpr reference front() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000309 {
Louis Dionne0c12d932020-02-14 14:31:15 +0100310 _LIBCPP_ASSERT(!empty(), "span<T, N>::front() on empty span");
Marshall Clow89408802019-02-25 17:54:08 +0000311 return __data[0];
312 }
313
314 _LIBCPP_INLINE_VISIBILITY constexpr reference back() const noexcept
315 {
Louis Dionne0c12d932020-02-14 14:31:15 +0100316 _LIBCPP_ASSERT(!empty(), "span<T, N>::back() on empty span");
Marshall Clow89408802019-02-25 17:54:08 +0000317 return __data[size()-1];
Louis Dionne44bcff92018-08-03 22:36:53 +0000318 }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000319
320 _LIBCPP_INLINE_VISIBILITY constexpr pointer data() const noexcept { return __data; }
321
322// [span.iter], span iterator support
323 _LIBCPP_INLINE_VISIBILITY constexpr iterator begin() const noexcept { return iterator(data()); }
324 _LIBCPP_INLINE_VISIBILITY constexpr iterator end() const noexcept { return iterator(data() + size()); }
325 _LIBCPP_INLINE_VISIBILITY constexpr const_iterator cbegin() const noexcept { return const_iterator(data()); }
326 _LIBCPP_INLINE_VISIBILITY constexpr const_iterator cend() const noexcept { return const_iterator(data() + size()); }
327 _LIBCPP_INLINE_VISIBILITY constexpr reverse_iterator rbegin() const noexcept { return reverse_iterator(end()); }
328 _LIBCPP_INLINE_VISIBILITY constexpr reverse_iterator rend() const noexcept { return reverse_iterator(begin()); }
329 _LIBCPP_INLINE_VISIBILITY constexpr const_reverse_iterator crbegin() const noexcept { return const_reverse_iterator(cend()); }
330 _LIBCPP_INLINE_VISIBILITY constexpr const_reverse_iterator crend() const noexcept { return const_reverse_iterator(cbegin()); }
331
332 _LIBCPP_INLINE_VISIBILITY constexpr void swap(span &__other) noexcept
333 {
334 pointer __p = __data;
335 __data = __other.__data;
336 __other.__data = __p;
337 }
Louis Dionne44bcff92018-08-03 22:36:53 +0000338
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000339 _LIBCPP_INLINE_VISIBILITY span<const byte, _Extent * sizeof(element_type)> __as_bytes() const noexcept
340 { return {reinterpret_cast<const byte *>(data()), size_bytes()}; }
341
Louis Dionneac9f0c62019-03-28 01:27:52 +0000342 _LIBCPP_INLINE_VISIBILITY span<byte, _Extent * sizeof(element_type)> __as_writable_bytes() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000343 { return {reinterpret_cast<byte *>(data()), size_bytes()}; }
344
345private:
346 pointer __data;
347
348};
349
350
351template <typename _Tp>
352class _LIBCPP_TEMPLATE_VIS span<_Tp, dynamic_extent> {
353private:
354
355public:
356// constants and types
357 using element_type = _Tp;
358 using value_type = remove_cv_t<_Tp>;
Louis Dionne7b89ab02019-11-14 09:07:05 -0500359 using size_type = size_t;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000360 using difference_type = ptrdiff_t;
361 using pointer = _Tp *;
Marshall Clow4b7f2c32019-02-25 17:58:03 +0000362 using const_pointer = const _Tp *;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000363 using reference = _Tp &;
Marshall Clow4b7f2c32019-02-25 17:58:03 +0000364 using const_reference = const _Tp &;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000365 using iterator = __wrap_iter<pointer>;
366 using const_iterator = __wrap_iter<const_pointer>;
367 using reverse_iterator = _VSTD::reverse_iterator<iterator>;
368 using const_reverse_iterator = _VSTD::reverse_iterator<const_iterator>;
369
Louis Dionne7b89ab02019-11-14 09:07:05 -0500370 static constexpr size_type extent = dynamic_extent;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000371
Louis Dionne44bcff92018-08-03 22:36:53 +0000372// [span.cons], span constructors, copy, assignment, and destructor
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000373 _LIBCPP_INLINE_VISIBILITY constexpr span() noexcept : __data{nullptr}, __size{0} {}
374
375 constexpr span (const span&) noexcept = default;
376 constexpr span& operator=(const span&) noexcept = default;
377
Louis Dionne7b89ab02019-11-14 09:07:05 -0500378 _LIBCPP_INLINE_VISIBILITY constexpr span(pointer __ptr, size_type __count) : __data{__ptr}, __size{__count} {}
Marshall Clowcd6d8802019-02-27 00:32:16 +0000379 _LIBCPP_INLINE_VISIBILITY constexpr span(pointer __f, pointer __l) : __data{__f}, __size{static_cast<size_t>(distance(__f, __l))} {}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000380
381 template <size_t _Sz>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000382 _LIBCPP_INLINE_VISIBILITY
383 constexpr span(element_type (&__arr)[_Sz]) noexcept : __data{__arr}, __size{_Sz} {}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000384
385 template <size_t _Sz>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000386 _LIBCPP_INLINE_VISIBILITY
387 constexpr span(array<value_type, _Sz>& __arr) noexcept : __data{__arr.data()}, __size{_Sz} {}
Louis Dionne44bcff92018-08-03 22:36:53 +0000388
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000389 template <size_t _Sz>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000390 _LIBCPP_INLINE_VISIBILITY
391 constexpr span(const array<value_type, _Sz>& __arr) noexcept : __data{__arr.data()}, __size{_Sz} {}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000392
393 template <class _Container>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000394 _LIBCPP_INLINE_VISIBILITY
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000395 constexpr span( _Container& __c,
396 enable_if_t<__is_span_compatible_container<_Container, _Tp>::value, nullptr_t> = nullptr)
Louis Dionne7b89ab02019-11-14 09:07:05 -0500397 : __data{_VSTD::data(__c)}, __size{(size_type) _VSTD::size(__c)} {}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000398
399 template <class _Container>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000400 _LIBCPP_INLINE_VISIBILITY
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000401 constexpr span(const _Container& __c,
402 enable_if_t<__is_span_compatible_container<const _Container, _Tp>::value, nullptr_t> = nullptr)
Louis Dionne7b89ab02019-11-14 09:07:05 -0500403 : __data{_VSTD::data(__c)}, __size{(size_type) _VSTD::size(__c)} {}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000404
405
Marshall Clowcd6d8802019-02-27 00:32:16 +0000406 template <class _OtherElementType, size_t _OtherExtent>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000407 _LIBCPP_INLINE_VISIBILITY
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000408 constexpr span(const span<_OtherElementType, _OtherExtent>& __other,
409 enable_if_t<
410 is_convertible_v<_OtherElementType(*)[], element_type (*)[]>,
411 nullptr_t> = nullptr) noexcept
412 : __data{__other.data()}, __size{__other.size()} {}
413
414// ~span() noexcept = default;
415
Marshall Clowcd6d8802019-02-27 00:32:16 +0000416 template <size_t _Count>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000417 _LIBCPP_INLINE_VISIBILITY
418 constexpr span<element_type, _Count> first() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000419 {
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000420 _LIBCPP_ASSERT(_Count <= size(), "Count out of range in span::first()");
421 return {data(), _Count};
422 }
423
Marshall Clowcd6d8802019-02-27 00:32:16 +0000424 template <size_t _Count>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000425 _LIBCPP_INLINE_VISIBILITY
426 constexpr span<element_type, _Count> last() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000427 {
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000428 _LIBCPP_ASSERT(_Count <= size(), "Count out of range in span::last()");
429 return {data() + size() - _Count, _Count};
430 }
431
432 _LIBCPP_INLINE_VISIBILITY
Louis Dionne7b89ab02019-11-14 09:07:05 -0500433 constexpr span<element_type, dynamic_extent> first(size_type __count) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000434 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000435 _LIBCPP_ASSERT(__count <= size(), "Count out of range in span::first(count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000436 return {data(), __count};
437 }
Louis Dionne44bcff92018-08-03 22:36:53 +0000438
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000439 _LIBCPP_INLINE_VISIBILITY
Louis Dionne7b89ab02019-11-14 09:07:05 -0500440 constexpr span<element_type, dynamic_extent> last (size_type __count) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000441 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000442 _LIBCPP_ASSERT(__count <= size(), "Count out of range in span::last(count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000443 return {data() + size() - __count, __count};
444 }
445
Marshall Clowcd6d8802019-02-27 00:32:16 +0000446 template <size_t _Offset, size_t _Count = dynamic_extent>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000447 _LIBCPP_INLINE_VISIBILITY
Louis Dionne22c735e2020-02-11 11:57:35 +0100448 constexpr span<element_type, _Count> subspan() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000449 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000450 _LIBCPP_ASSERT(_Offset <= size(), "Offset out of range in span::subspan()");
Louis Dionne45931e92020-02-12 16:20:09 +0100451 _LIBCPP_ASSERT(_Count == dynamic_extent || _Count <= size() - _Offset, "Offset + count out of range in span::subspan()");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000452 return {data() + _Offset, _Count == dynamic_extent ? size() - _Offset : _Count};
453 }
454
455 constexpr span<element_type, dynamic_extent>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000456 _LIBCPP_INLINE_VISIBILITY
Louis Dionne7b89ab02019-11-14 09:07:05 -0500457 subspan(size_type __offset, size_type __count = dynamic_extent) const noexcept
Louis Dionne44bcff92018-08-03 22:36:53 +0000458 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000459 _LIBCPP_ASSERT(__offset <= size(), "Offset out of range in span::subspan(offset, count)");
460 _LIBCPP_ASSERT(__count <= size() || __count == dynamic_extent, "count out of range in span::subspan(offset, count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000461 if (__count == dynamic_extent)
462 return {data() + __offset, size() - __offset};
Louis Dionne45931e92020-02-12 16:20:09 +0100463 _LIBCPP_ASSERT(__count <= size() - __offset, "Offset + count out of range in span::subspan(offset, count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000464 return {data() + __offset, __count};
465 }
466
Louis Dionne7b89ab02019-11-14 09:07:05 -0500467 _LIBCPP_INLINE_VISIBILITY constexpr size_type size() const noexcept { return __size; }
468 _LIBCPP_INLINE_VISIBILITY constexpr size_type size_bytes() const noexcept { return __size * sizeof(element_type); }
469 _LIBCPP_INLINE_VISIBILITY constexpr bool empty() const noexcept { return __size == 0; }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000470
Louis Dionne7b89ab02019-11-14 09:07:05 -0500471 _LIBCPP_INLINE_VISIBILITY constexpr reference operator[](size_type __idx) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000472 {
Louis Dionne956eca82020-02-11 11:38:00 +0100473 _LIBCPP_ASSERT(__idx < size(), "span<T>[] index out of bounds");
Louis Dionne44bcff92018-08-03 22:36:53 +0000474 return __data[__idx];
475 }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000476
Marshall Clow89408802019-02-25 17:54:08 +0000477 _LIBCPP_INLINE_VISIBILITY constexpr reference front() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000478 {
Marshall Clow89408802019-02-25 17:54:08 +0000479 _LIBCPP_ASSERT(!empty(), "span<T>[].front() on empty span");
480 return __data[0];
Louis Dionne44bcff92018-08-03 22:36:53 +0000481 }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000482
Marshall Clow89408802019-02-25 17:54:08 +0000483 _LIBCPP_INLINE_VISIBILITY constexpr reference back() const noexcept
484 {
485 _LIBCPP_ASSERT(!empty(), "span<T>[].back() on empty span");
486 return __data[size()-1];
487 }
488
489
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000490 _LIBCPP_INLINE_VISIBILITY constexpr pointer data() const noexcept { return __data; }
491
492// [span.iter], span iterator support
493 _LIBCPP_INLINE_VISIBILITY constexpr iterator begin() const noexcept { return iterator(data()); }
494 _LIBCPP_INLINE_VISIBILITY constexpr iterator end() const noexcept { return iterator(data() + size()); }
495 _LIBCPP_INLINE_VISIBILITY constexpr const_iterator cbegin() const noexcept { return const_iterator(data()); }
496 _LIBCPP_INLINE_VISIBILITY constexpr const_iterator cend() const noexcept { return const_iterator(data() + size()); }
497 _LIBCPP_INLINE_VISIBILITY constexpr reverse_iterator rbegin() const noexcept { return reverse_iterator(end()); }
498 _LIBCPP_INLINE_VISIBILITY constexpr reverse_iterator rend() const noexcept { return reverse_iterator(begin()); }
499 _LIBCPP_INLINE_VISIBILITY constexpr const_reverse_iterator crbegin() const noexcept { return const_reverse_iterator(cend()); }
500 _LIBCPP_INLINE_VISIBILITY constexpr const_reverse_iterator crend() const noexcept { return const_reverse_iterator(cbegin()); }
501
502 _LIBCPP_INLINE_VISIBILITY constexpr void swap(span &__other) noexcept
503 {
504 pointer __p = __data;
505 __data = __other.__data;
506 __other.__data = __p;
507
Louis Dionne7b89ab02019-11-14 09:07:05 -0500508 size_type __sz = __size;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000509 __size = __other.__size;
510 __other.__size = __sz;
511 }
512
513 _LIBCPP_INLINE_VISIBILITY span<const byte, dynamic_extent> __as_bytes() const noexcept
514 { return {reinterpret_cast<const byte *>(data()), size_bytes()}; }
515
Louis Dionneac9f0c62019-03-28 01:27:52 +0000516 _LIBCPP_INLINE_VISIBILITY span<byte, dynamic_extent> __as_writable_bytes() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000517 { return {reinterpret_cast<byte *>(data()), size_bytes()}; }
518
519private:
Louis Dionne7b89ab02019-11-14 09:07:05 -0500520 pointer __data;
521 size_type __size;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000522};
523
Marshall Clowe4859a02019-02-27 15:41:37 +0000524// tuple interface
525template <class _Tp, size_t _Size>
526struct _LIBCPP_TEMPLATE_VIS tuple_size<span<_Tp, _Size>>
527 : public integral_constant<size_t, _Size> {};
528
529template <class _Tp>
530struct _LIBCPP_TEMPLATE_VIS tuple_size<span<_Tp, dynamic_extent>>; // declared but not defined
531
532
533template <size_t _Ip, class _Tp, size_t _Size>
Louis Dionnee684aa62019-04-01 16:39:34 +0000534struct _LIBCPP_TEMPLATE_VIS tuple_element<_Ip, span<_Tp, _Size>>
Marshall Clowe4859a02019-02-27 15:41:37 +0000535{
536 static_assert( dynamic_extent != _Size, "std::tuple_element<> not supported for std::span<T, dynamic_extent>");
537 static_assert(_Ip < _Size, "Index out of bounds in std::tuple_element<> (std::span)");
Marshall Clowe4859a02019-02-27 15:41:37 +0000538 typedef _Tp type;
539};
540
541template <size_t _Ip, class _Tp, size_t _Size>
542_LIBCPP_INLINE_VISIBILITY constexpr
543_Tp&
544get(span<_Tp, _Size> __s) noexcept
545{
546 static_assert( dynamic_extent != _Size, "std::get<> not supported for std::span<T, dynamic_extent>");
547 static_assert(_Ip < _Size, "Index out of bounds in std::get<> (std::span)");
548 return __s[_Ip];
549}
550
551
Louis Dionneac9f0c62019-03-28 01:27:52 +0000552// as_bytes & as_writable_bytes
Marshall Clowcd6d8802019-02-27 00:32:16 +0000553template <class _Tp, size_t _Extent>
Marshall Clowe4859a02019-02-27 15:41:37 +0000554_LIBCPP_INLINE_VISIBILITY
555auto as_bytes(span<_Tp, _Extent> __s) noexcept
556-> decltype(__s.__as_bytes())
557{ return __s.__as_bytes(); }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000558
Marshall Clowcd6d8802019-02-27 00:32:16 +0000559template <class _Tp, size_t _Extent>
Marshall Clowe4859a02019-02-27 15:41:37 +0000560_LIBCPP_INLINE_VISIBILITY
Louis Dionneac9f0c62019-03-28 01:27:52 +0000561auto as_writable_bytes(span<_Tp, _Extent> __s) noexcept
562-> enable_if_t<!is_const_v<_Tp>, decltype(__s.__as_writable_bytes())>
563{ return __s.__as_writable_bytes(); }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000564
Marshall Clowcd6d8802019-02-27 00:32:16 +0000565template <class _Tp, size_t _Extent>
Marshall Clowe4859a02019-02-27 15:41:37 +0000566_LIBCPP_INLINE_VISIBILITY
567constexpr void swap(span<_Tp, _Extent> &__lhs, span<_Tp, _Extent> &__rhs) noexcept
568{ __lhs.swap(__rhs); }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000569
570
571// Deduction guides
572template<class _Tp, size_t _Sz>
573 span(_Tp (&)[_Sz]) -> span<_Tp, _Sz>;
Louis Dionne44bcff92018-08-03 22:36:53 +0000574
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000575template<class _Tp, size_t _Sz>
576 span(array<_Tp, _Sz>&) -> span<_Tp, _Sz>;
577
578template<class _Tp, size_t _Sz>
579 span(const array<_Tp, _Sz>&) -> span<const _Tp, _Sz>;
580
581template<class _Container>
582 span(_Container&) -> span<typename _Container::value_type>;
583
584template<class _Container>
585 span(const _Container&) -> span<const typename _Container::value_type>;
586
Marshall Clow8dc3ea12018-07-24 03:56:38 +0000587#endif // _LIBCPP_STD_VER > 17
588
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000589_LIBCPP_END_NAMESPACE_STD
590
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000591#endif // _LIBCPP_SPAN