blob: 4c621abe80f3405ac87b123b1e637d43f6020652 [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
Mark de Weveraf59b2d2020-11-24 18:08:02 +010025template<class ElementType, size_t Extent>
26 inline constexpr bool ranges::enable_borrowed_range<span<ElementType, Extent>> = true;
27
Marshall Clowd2ad87e2018-07-24 03:01:02 +000028// [span.objectrep], views of object representation
Marshall Clowcd6d8802019-02-27 00:32:16 +000029template <class ElementType, size_t Extent>
Louis Dionne44bcff92018-08-03 22:36:53 +000030 span<const byte, ((Extent == dynamic_extent) ? dynamic_extent :
Marshall Clowe246c9f2019-03-06 03:59:44 +000031 (sizeof(ElementType) * Extent))> as_bytes(span<ElementType, Extent> s) noexcept;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000032
Marshall Clowcd6d8802019-02-27 00:32:16 +000033template <class ElementType, size_t Extent>
Louis Dionne44bcff92018-08-03 22:36:53 +000034 span< byte, ((Extent == dynamic_extent) ? dynamic_extent :
Marshall Clowe246c9f2019-03-06 03:59:44 +000035 (sizeof(ElementType) * Extent))> as_writable_bytes(span<ElementType, Extent> s) noexcept;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000036
37
Marshall Clowcd6d8802019-02-27 00:32:16 +000038template <class ElementType, size_t Extent = dynamic_extent>
Marshall Clowd2ad87e2018-07-24 03:01:02 +000039class span {
40public:
41 // constants and types
42 using element_type = ElementType;
43 using value_type = remove_cv_t<ElementType>;
Louis Dionne7b89ab02019-11-14 09:07:05 -050044 using size_type = size_t;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000045 using difference_type = ptrdiff_t;
46 using pointer = element_type*;
Marshall Clow4b7f2c32019-02-25 17:58:03 +000047 using const_pointer = const element_type*;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000048 using reference = element_type&;
Marshall Clow4b7f2c32019-02-25 17:58:03 +000049 using const_reference = const element_type&;
Marshall Clowcd6d8802019-02-27 00:32:16 +000050 using iterator = implementation-defined;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000051 using reverse_iterator = std::reverse_iterator<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;
Michael Schellenberger Costaea234282020-05-13 09:50:06 -040056 constexpr explicit(Extent != dynamic_extent) span(pointer ptr, size_type count);
57 constexpr explicit(Extent != dynamic_extent) span(pointer firstElem, pointer lastElem);
Marshall Clowd2ad87e2018-07-24 03:01:02 +000058 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>
Michael Schellenberger Costaea234282020-05-13 09:50:06 -040065 constexpr explicit(Extent != dynamic_extent) span(Container& cont);
Marshall Clowd2ad87e2018-07-24 03:01:02 +000066 template <class Container>
Michael Schellenberger Costaea234282020-05-13 09:50:06 -040067 constexpr explicit(Extent != dynamic_extent) span(const Container& cont);
Marshall Clowd2ad87e2018-07-24 03:01:02 +000068 constexpr span(const span& other) noexcept = default;
Marshall Clowcd6d8802019-02-27 00:32:16 +000069 template <class OtherElementType, size_t OtherExtent>
Michael Schellenberger Costaea234282020-05-13 09:50:06 -040070 constexpr explicit(Extent != dynamic_extent) span(const span<OtherElementType, OtherExtent>& s) noexcept;
Marshall Clowd2ad87e2018-07-24 03:01:02 +000071 ~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;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000100 constexpr reverse_iterator rbegin() const noexcept;
101 constexpr reverse_iterator rend() const noexcept;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000102
103private:
Louis Dionne7b89ab02019-11-14 09:07:05 -0500104 pointer data_; // exposition only
105 size_type size_; // exposition only
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000106};
107
108template<class T, size_t N>
109 span(T (&)[N]) -> span<T, N>;
Louis Dionne44bcff92018-08-03 22:36:53 +0000110
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000111template<class T, size_t N>
112 span(array<T, N>&) -> span<T, N>;
113
114template<class T, size_t N>
115 span(const array<T, N>&) -> span<const T, N>;
116
117template<class Container>
118 span(Container&) -> span<typename Container::value_type>;
119
120template<class Container>
121 span(const Container&) -> span<const typename Container::value_type>;
122
123} // namespace std
124
125*/
126
Marshall Clow8dc3ea12018-07-24 03:56:38 +0000127#include <__config>
Mark de Weveraf59b2d2020-11-24 18:08:02 +0100128#include <__ranges/enable_borrowed_range.h>
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000129#include <array> // for array
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000130#include <cstddef> // for byte
Louis Dionne533a14e2020-02-11 11:16:40 +0100131#include <iterator> // for iterators
132#include <type_traits> // for remove_cv, etc
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000133
134#if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
135#pragma GCC system_header
136#endif
137
Arthur O'Dwyer518c1842020-11-27 14:13:05 -0500138_LIBCPP_PUSH_MACROS
139#include <__undef_macros>
140
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000141_LIBCPP_BEGIN_NAMESPACE_STD
142
143#if _LIBCPP_STD_VER > 17
144
Arthur O'Dwyer518c1842020-11-27 14:13:05 -0500145inline 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 &;
Arthur O'Dwyer0a5557f2021-04-20 22:08:00 -0400203#if (_LIBCPP_DEBUG_LEVEL == 2) || defined(_LIBCPP_ABI_SPAN_POINTER_ITERATORS)
204 using iterator = pointer;
205#else
206 using iterator = __wrap_iter<pointer>;
207#endif
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000208 using reverse_iterator = _VSTD::reverse_iterator<iterator>;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000209
Louis Dionne7b89ab02019-11-14 09:07:05 -0500210 static constexpr size_type extent = _Extent;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000211
Louis Dionne44bcff92018-08-03 22:36:53 +0000212// [span.cons], span constructors, copy, assignment, and destructor
Michael Schellenberger Costa11807352020-05-14 09:28:27 -0400213 template <size_t _Sz = _Extent, enable_if_t<_Sz == 0, nullptr_t> = nullptr>
214 _LIBCPP_INLINE_VISIBILITY constexpr span() noexcept : __data{nullptr} {}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000215
216 constexpr span (const span&) noexcept = default;
217 constexpr span& operator=(const span&) noexcept = default;
218
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400219 _LIBCPP_INLINE_VISIBILITY constexpr explicit span(pointer __ptr, size_type __count) : __data{__ptr}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000220 { (void)__count; _LIBCPP_ASSERT(_Extent == __count, "size mismatch in span's constructor (ptr, len)"); }
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400221 _LIBCPP_INLINE_VISIBILITY constexpr explicit span(pointer __f, pointer __l) : __data{__f}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000222 { (void)__l; _LIBCPP_ASSERT(_Extent == distance(__f, __l), "size mismatch in span's constructor (ptr, ptr)"); }
223
224 _LIBCPP_INLINE_VISIBILITY constexpr span(element_type (&__arr)[_Extent]) noexcept : __data{__arr} {}
Michael Schellenberger Costab0444f32020-05-14 10:50:03 -0400225
226 template <class _OtherElementType,
227 enable_if_t<is_convertible_v<_OtherElementType(*)[], element_type (*)[]>, nullptr_t> = nullptr>
228 _LIBCPP_INLINE_VISIBILITY
229 constexpr span(array<_OtherElementType, _Extent>& __arr) noexcept : __data{__arr.data()} {}
230
231 template <class _OtherElementType,
232 enable_if_t<is_convertible_v<const _OtherElementType(*)[], element_type (*)[]>, nullptr_t> = nullptr>
233 _LIBCPP_INLINE_VISIBILITY
234 constexpr span(const array<_OtherElementType, _Extent>& __arr) noexcept : __data{__arr.data()} {}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000235
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400236 template <class _Container>
237 _LIBCPP_INLINE_VISIBILITY
238 constexpr explicit span( _Container& __c,
239 enable_if_t<__is_span_compatible_container<_Container, _Tp>::value, nullptr_t> = nullptr)
240 : __data{_VSTD::data(__c)} {
241 _LIBCPP_ASSERT(_Extent == _VSTD::size(__c), "size mismatch in span's constructor (range)");
242 }
243
244 template <class _Container>
245 _LIBCPP_INLINE_VISIBILITY
246 constexpr explicit span(const _Container& __c,
247 enable_if_t<__is_span_compatible_container<const _Container, _Tp>::value, nullptr_t> = nullptr)
248 : __data{_VSTD::data(__c)} {
249 _LIBCPP_ASSERT(_Extent == _VSTD::size(__c), "size mismatch in span's constructor (range)");
250 }
251
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000252 template <class _OtherElementType>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000253 _LIBCPP_INLINE_VISIBILITY
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000254 constexpr span(const span<_OtherElementType, _Extent>& __other,
255 enable_if_t<
256 is_convertible_v<_OtherElementType(*)[], element_type (*)[]>,
257 nullptr_t> = nullptr)
258 : __data{__other.data()} {}
259
260 template <class _OtherElementType>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000261 _LIBCPP_INLINE_VISIBILITY
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400262 constexpr explicit span(const span<_OtherElementType, dynamic_extent>& __other,
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000263 enable_if_t<
264 is_convertible_v<_OtherElementType(*)[], element_type (*)[]>,
265 nullptr_t> = nullptr) noexcept
266 : __data{__other.data()} { _LIBCPP_ASSERT(_Extent == __other.size(), "size mismatch in span's constructor (other span)"); }
267
268
269// ~span() noexcept = default;
270
Marshall Clowcd6d8802019-02-27 00:32:16 +0000271 template <size_t _Count>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000272 _LIBCPP_INLINE_VISIBILITY
273 constexpr span<element_type, _Count> first() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000274 {
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000275 static_assert(_Count <= _Extent, "Count out of range in span::first()");
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400276 return span<element_type, _Count>{data(), _Count};
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000277 }
278
Marshall Clowcd6d8802019-02-27 00:32:16 +0000279 template <size_t _Count>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000280 _LIBCPP_INLINE_VISIBILITY
281 constexpr span<element_type, _Count> last() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000282 {
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000283 static_assert(_Count <= _Extent, "Count out of range in span::last()");
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400284 return span<element_type, _Count>{data() + size() - _Count, _Count};
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000285 }
Louis Dionne44bcff92018-08-03 22:36:53 +0000286
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000287 _LIBCPP_INLINE_VISIBILITY
Louis Dionne7b89ab02019-11-14 09:07:05 -0500288 constexpr span<element_type, dynamic_extent> first(size_type __count) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000289 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000290 _LIBCPP_ASSERT(__count <= size(), "Count out of range in span::first(count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000291 return {data(), __count};
292 }
293
294 _LIBCPP_INLINE_VISIBILITY
Louis Dionne7b89ab02019-11-14 09:07:05 -0500295 constexpr span<element_type, dynamic_extent> last(size_type __count) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000296 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000297 _LIBCPP_ASSERT(__count <= size(), "Count out of range in span::last(count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000298 return {data() + size() - __count, __count};
299 }
300
Marshall Clowcd6d8802019-02-27 00:32:16 +0000301 template <size_t _Offset, size_t _Count = dynamic_extent>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000302 _LIBCPP_INLINE_VISIBILITY
303 constexpr auto subspan() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000304 -> span<element_type, _Count != dynamic_extent ? _Count : _Extent - _Offset>
305 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000306 static_assert(_Offset <= _Extent, "Offset out of range in span::subspan()");
Louis Dionne45931e92020-02-12 16:20:09 +0100307 static_assert(_Count == dynamic_extent || _Count <= _Extent - _Offset, "Offset + count out of range in span::subspan()");
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400308
309 using _ReturnType = span<element_type, _Count != dynamic_extent ? _Count : _Extent - _Offset>;
310 return _ReturnType{data() + _Offset, _Count == dynamic_extent ? size() - _Offset : _Count};
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000311 }
312
313
Marshall Clowe246c9f2019-03-06 03:59:44 +0000314 _LIBCPP_INLINE_VISIBILITY
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000315 constexpr span<element_type, dynamic_extent>
Louis Dionne7b89ab02019-11-14 09:07:05 -0500316 subspan(size_type __offset, size_type __count = dynamic_extent) const noexcept
Louis Dionne44bcff92018-08-03 22:36:53 +0000317 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000318 _LIBCPP_ASSERT(__offset <= size(), "Offset out of range in span::subspan(offset, count)");
319 _LIBCPP_ASSERT(__count <= size() || __count == dynamic_extent, "Count out of range in span::subspan(offset, count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000320 if (__count == dynamic_extent)
321 return {data() + __offset, size() - __offset};
Louis Dionne45931e92020-02-12 16:20:09 +0100322 _LIBCPP_ASSERT(__count <= size() - __offset, "Offset + count out of range in span::subspan(offset, count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000323 return {data() + __offset, __count};
324 }
325
Louis Dionne7b89ab02019-11-14 09:07:05 -0500326 _LIBCPP_INLINE_VISIBILITY constexpr size_type size() const noexcept { return _Extent; }
327 _LIBCPP_INLINE_VISIBILITY constexpr size_type size_bytes() const noexcept { return _Extent * sizeof(element_type); }
328 _LIBCPP_INLINE_VISIBILITY constexpr bool empty() const noexcept { return _Extent == 0; }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000329
Louis Dionne7b89ab02019-11-14 09:07:05 -0500330 _LIBCPP_INLINE_VISIBILITY constexpr reference operator[](size_type __idx) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000331 {
Louis Dionne956eca82020-02-11 11:38:00 +0100332 _LIBCPP_ASSERT(__idx < size(), "span<T,N>[] index out of bounds");
Louis Dionne44bcff92018-08-03 22:36:53 +0000333 return __data[__idx];
334 }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000335
Marshall Clow89408802019-02-25 17:54:08 +0000336 _LIBCPP_INLINE_VISIBILITY constexpr reference front() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000337 {
Louis Dionne0c12d932020-02-14 14:31:15 +0100338 _LIBCPP_ASSERT(!empty(), "span<T, N>::front() on empty span");
Marshall Clow89408802019-02-25 17:54:08 +0000339 return __data[0];
340 }
341
342 _LIBCPP_INLINE_VISIBILITY constexpr reference back() const noexcept
343 {
Louis Dionne0c12d932020-02-14 14:31:15 +0100344 _LIBCPP_ASSERT(!empty(), "span<T, N>::back() on empty span");
Marshall Clow89408802019-02-25 17:54:08 +0000345 return __data[size()-1];
Louis Dionne44bcff92018-08-03 22:36:53 +0000346 }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000347
348 _LIBCPP_INLINE_VISIBILITY constexpr pointer data() const noexcept { return __data; }
349
350// [span.iter], span iterator support
351 _LIBCPP_INLINE_VISIBILITY constexpr iterator begin() const noexcept { return iterator(data()); }
352 _LIBCPP_INLINE_VISIBILITY constexpr iterator end() const noexcept { return iterator(data() + size()); }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000353 _LIBCPP_INLINE_VISIBILITY constexpr reverse_iterator rbegin() const noexcept { return reverse_iterator(end()); }
354 _LIBCPP_INLINE_VISIBILITY constexpr reverse_iterator rend() const noexcept { return reverse_iterator(begin()); }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000355
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000356 _LIBCPP_INLINE_VISIBILITY span<const byte, _Extent * sizeof(element_type)> __as_bytes() const noexcept
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400357 { return span<const byte, _Extent * sizeof(element_type)>{reinterpret_cast<const byte *>(data()), size_bytes()}; }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000358
Louis Dionneac9f0c62019-03-28 01:27:52 +0000359 _LIBCPP_INLINE_VISIBILITY span<byte, _Extent * sizeof(element_type)> __as_writable_bytes() const noexcept
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400360 { return span<byte, _Extent * sizeof(element_type)>{reinterpret_cast<byte *>(data()), size_bytes()}; }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000361
362private:
363 pointer __data;
364
365};
366
367
368template <typename _Tp>
369class _LIBCPP_TEMPLATE_VIS span<_Tp, dynamic_extent> {
370private:
371
372public:
373// constants and types
374 using element_type = _Tp;
375 using value_type = remove_cv_t<_Tp>;
Louis Dionne7b89ab02019-11-14 09:07:05 -0500376 using size_type = size_t;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000377 using difference_type = ptrdiff_t;
378 using pointer = _Tp *;
Marshall Clow4b7f2c32019-02-25 17:58:03 +0000379 using const_pointer = const _Tp *;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000380 using reference = _Tp &;
Marshall Clow4b7f2c32019-02-25 17:58:03 +0000381 using const_reference = const _Tp &;
Arthur O'Dwyer0a5557f2021-04-20 22:08:00 -0400382#if (_LIBCPP_DEBUG_LEVEL == 2) || defined(_LIBCPP_ABI_SPAN_POINTER_ITERATORS)
383 using iterator = pointer;
384#else
385 using iterator = __wrap_iter<pointer>;
386#endif
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000387 using reverse_iterator = _VSTD::reverse_iterator<iterator>;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000388
Louis Dionne7b89ab02019-11-14 09:07:05 -0500389 static constexpr size_type extent = dynamic_extent;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000390
Louis Dionne44bcff92018-08-03 22:36:53 +0000391// [span.cons], span constructors, copy, assignment, and destructor
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000392 _LIBCPP_INLINE_VISIBILITY constexpr span() noexcept : __data{nullptr}, __size{0} {}
393
394 constexpr span (const span&) noexcept = default;
395 constexpr span& operator=(const span&) noexcept = default;
396
Louis Dionne7b89ab02019-11-14 09:07:05 -0500397 _LIBCPP_INLINE_VISIBILITY constexpr span(pointer __ptr, size_type __count) : __data{__ptr}, __size{__count} {}
Marshall Clowcd6d8802019-02-27 00:32:16 +0000398 _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 +0000399
400 template <size_t _Sz>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000401 _LIBCPP_INLINE_VISIBILITY
402 constexpr span(element_type (&__arr)[_Sz]) noexcept : __data{__arr}, __size{_Sz} {}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000403
Michael Schellenberger Costab0444f32020-05-14 10:50:03 -0400404 template <class _OtherElementType, size_t _Sz,
405 enable_if_t<is_convertible_v<_OtherElementType(*)[], element_type (*)[]>, nullptr_t> = nullptr>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000406 _LIBCPP_INLINE_VISIBILITY
Michael Schellenberger Costab0444f32020-05-14 10:50:03 -0400407 constexpr span(array<_OtherElementType, _Sz>& __arr) noexcept : __data{__arr.data()}, __size{_Sz} {}
Louis Dionne44bcff92018-08-03 22:36:53 +0000408
Michael Schellenberger Costab0444f32020-05-14 10:50:03 -0400409 template <class _OtherElementType, size_t _Sz,
410 enable_if_t<is_convertible_v<const _OtherElementType(*)[], element_type (*)[]>, nullptr_t> = nullptr>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000411 _LIBCPP_INLINE_VISIBILITY
Michael Schellenberger Costab0444f32020-05-14 10:50:03 -0400412 constexpr span(const array<_OtherElementType, _Sz>& __arr) noexcept : __data{__arr.data()}, __size{_Sz} {}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000413
414 template <class _Container>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000415 _LIBCPP_INLINE_VISIBILITY
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000416 constexpr span( _Container& __c,
417 enable_if_t<__is_span_compatible_container<_Container, _Tp>::value, nullptr_t> = nullptr)
Louis Dionne7b89ab02019-11-14 09:07:05 -0500418 : __data{_VSTD::data(__c)}, __size{(size_type) _VSTD::size(__c)} {}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000419
420 template <class _Container>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000421 _LIBCPP_INLINE_VISIBILITY
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000422 constexpr span(const _Container& __c,
423 enable_if_t<__is_span_compatible_container<const _Container, _Tp>::value, nullptr_t> = nullptr)
Louis Dionne7b89ab02019-11-14 09:07:05 -0500424 : __data{_VSTD::data(__c)}, __size{(size_type) _VSTD::size(__c)} {}
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000425
426
Marshall Clowcd6d8802019-02-27 00:32:16 +0000427 template <class _OtherElementType, size_t _OtherExtent>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000428 _LIBCPP_INLINE_VISIBILITY
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000429 constexpr span(const span<_OtherElementType, _OtherExtent>& __other,
430 enable_if_t<
431 is_convertible_v<_OtherElementType(*)[], element_type (*)[]>,
432 nullptr_t> = nullptr) noexcept
433 : __data{__other.data()}, __size{__other.size()} {}
434
435// ~span() noexcept = default;
436
Marshall Clowcd6d8802019-02-27 00:32:16 +0000437 template <size_t _Count>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000438 _LIBCPP_INLINE_VISIBILITY
439 constexpr span<element_type, _Count> first() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000440 {
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000441 _LIBCPP_ASSERT(_Count <= size(), "Count out of range in span::first()");
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400442 return span<element_type, _Count>{data(), _Count};
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000443 }
444
Marshall Clowcd6d8802019-02-27 00:32:16 +0000445 template <size_t _Count>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000446 _LIBCPP_INLINE_VISIBILITY
447 constexpr span<element_type, _Count> last() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000448 {
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000449 _LIBCPP_ASSERT(_Count <= size(), "Count out of range in span::last()");
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400450 return span<element_type, _Count>{data() + size() - _Count, _Count};
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000451 }
452
453 _LIBCPP_INLINE_VISIBILITY
Louis Dionne7b89ab02019-11-14 09:07:05 -0500454 constexpr span<element_type, dynamic_extent> first(size_type __count) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000455 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000456 _LIBCPP_ASSERT(__count <= size(), "Count out of range in span::first(count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000457 return {data(), __count};
458 }
Louis Dionne44bcff92018-08-03 22:36:53 +0000459
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000460 _LIBCPP_INLINE_VISIBILITY
Louis Dionne7b89ab02019-11-14 09:07:05 -0500461 constexpr span<element_type, dynamic_extent> last (size_type __count) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000462 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000463 _LIBCPP_ASSERT(__count <= size(), "Count out of range in span::last(count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000464 return {data() + size() - __count, __count};
465 }
466
Marshall Clowcd6d8802019-02-27 00:32:16 +0000467 template <size_t _Offset, size_t _Count = dynamic_extent>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000468 _LIBCPP_INLINE_VISIBILITY
Louis Dionne22c735e2020-02-11 11:57:35 +0100469 constexpr span<element_type, _Count> subspan() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000470 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000471 _LIBCPP_ASSERT(_Offset <= size(), "Offset out of range in span::subspan()");
Louis Dionne45931e92020-02-12 16:20:09 +0100472 _LIBCPP_ASSERT(_Count == dynamic_extent || _Count <= size() - _Offset, "Offset + count out of range in span::subspan()");
Michael Schellenberger Costaea234282020-05-13 09:50:06 -0400473 return span<element_type, _Count>{data() + _Offset, _Count == dynamic_extent ? size() - _Offset : _Count};
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000474 }
475
476 constexpr span<element_type, dynamic_extent>
Marshall Clowe246c9f2019-03-06 03:59:44 +0000477 _LIBCPP_INLINE_VISIBILITY
Louis Dionne7b89ab02019-11-14 09:07:05 -0500478 subspan(size_type __offset, size_type __count = dynamic_extent) const noexcept
Louis Dionne44bcff92018-08-03 22:36:53 +0000479 {
Marshall Clowe246c9f2019-03-06 03:59:44 +0000480 _LIBCPP_ASSERT(__offset <= size(), "Offset out of range in span::subspan(offset, count)");
481 _LIBCPP_ASSERT(__count <= size() || __count == dynamic_extent, "count out of range in span::subspan(offset, count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000482 if (__count == dynamic_extent)
483 return {data() + __offset, size() - __offset};
Louis Dionne45931e92020-02-12 16:20:09 +0100484 _LIBCPP_ASSERT(__count <= size() - __offset, "Offset + count out of range in span::subspan(offset, count)");
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000485 return {data() + __offset, __count};
486 }
487
Louis Dionne7b89ab02019-11-14 09:07:05 -0500488 _LIBCPP_INLINE_VISIBILITY constexpr size_type size() const noexcept { return __size; }
489 _LIBCPP_INLINE_VISIBILITY constexpr size_type size_bytes() const noexcept { return __size * sizeof(element_type); }
490 _LIBCPP_INLINE_VISIBILITY constexpr bool empty() const noexcept { return __size == 0; }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000491
Louis Dionne7b89ab02019-11-14 09:07:05 -0500492 _LIBCPP_INLINE_VISIBILITY constexpr reference operator[](size_type __idx) const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000493 {
Louis Dionne956eca82020-02-11 11:38:00 +0100494 _LIBCPP_ASSERT(__idx < size(), "span<T>[] index out of bounds");
Louis Dionne44bcff92018-08-03 22:36:53 +0000495 return __data[__idx];
496 }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000497
Marshall Clow89408802019-02-25 17:54:08 +0000498 _LIBCPP_INLINE_VISIBILITY constexpr reference front() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000499 {
Marshall Clow89408802019-02-25 17:54:08 +0000500 _LIBCPP_ASSERT(!empty(), "span<T>[].front() on empty span");
501 return __data[0];
Louis Dionne44bcff92018-08-03 22:36:53 +0000502 }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000503
Marshall Clow89408802019-02-25 17:54:08 +0000504 _LIBCPP_INLINE_VISIBILITY constexpr reference back() const noexcept
505 {
506 _LIBCPP_ASSERT(!empty(), "span<T>[].back() on empty span");
507 return __data[size()-1];
508 }
509
510
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000511 _LIBCPP_INLINE_VISIBILITY constexpr pointer data() const noexcept { return __data; }
512
513// [span.iter], span iterator support
514 _LIBCPP_INLINE_VISIBILITY constexpr iterator begin() const noexcept { return iterator(data()); }
515 _LIBCPP_INLINE_VISIBILITY constexpr iterator end() const noexcept { return iterator(data() + size()); }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000516 _LIBCPP_INLINE_VISIBILITY constexpr reverse_iterator rbegin() const noexcept { return reverse_iterator(end()); }
517 _LIBCPP_INLINE_VISIBILITY constexpr reverse_iterator rend() const noexcept { return reverse_iterator(begin()); }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000518
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000519 _LIBCPP_INLINE_VISIBILITY span<const byte, dynamic_extent> __as_bytes() const noexcept
520 { return {reinterpret_cast<const byte *>(data()), size_bytes()}; }
521
Louis Dionneac9f0c62019-03-28 01:27:52 +0000522 _LIBCPP_INLINE_VISIBILITY span<byte, dynamic_extent> __as_writable_bytes() const noexcept
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000523 { return {reinterpret_cast<byte *>(data()), size_bytes()}; }
524
525private:
Louis Dionne7b89ab02019-11-14 09:07:05 -0500526 pointer __data;
527 size_type __size;
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000528};
529
Mark de Weveraf59b2d2020-11-24 18:08:02 +0100530#if !defined(_LIBCPP_HAS_NO_RANGES)
531template <class _Tp, size_t _Extent>
532inline constexpr bool ranges::enable_borrowed_range<span<_Tp, _Extent> > = true;
533#endif // !defined(_LIBCPP_HAS_NO_RANGES)
534
Louis Dionneac9f0c62019-03-28 01:27:52 +0000535// as_bytes & as_writable_bytes
Marshall Clowcd6d8802019-02-27 00:32:16 +0000536template <class _Tp, size_t _Extent>
Marshall Clowe4859a02019-02-27 15:41:37 +0000537_LIBCPP_INLINE_VISIBILITY
538auto as_bytes(span<_Tp, _Extent> __s) noexcept
539-> decltype(__s.__as_bytes())
540{ return __s.__as_bytes(); }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000541
Marshall Clowcd6d8802019-02-27 00:32:16 +0000542template <class _Tp, size_t _Extent>
Marshall Clowe4859a02019-02-27 15:41:37 +0000543_LIBCPP_INLINE_VISIBILITY
Louis Dionneac9f0c62019-03-28 01:27:52 +0000544auto as_writable_bytes(span<_Tp, _Extent> __s) noexcept
545-> enable_if_t<!is_const_v<_Tp>, decltype(__s.__as_writable_bytes())>
546{ return __s.__as_writable_bytes(); }
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000547
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000548// Deduction guides
549template<class _Tp, size_t _Sz>
550 span(_Tp (&)[_Sz]) -> span<_Tp, _Sz>;
Louis Dionne44bcff92018-08-03 22:36:53 +0000551
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000552template<class _Tp, size_t _Sz>
553 span(array<_Tp, _Sz>&) -> span<_Tp, _Sz>;
554
555template<class _Tp, size_t _Sz>
556 span(const array<_Tp, _Sz>&) -> span<const _Tp, _Sz>;
557
558template<class _Container>
559 span(_Container&) -> span<typename _Container::value_type>;
560
561template<class _Container>
562 span(const _Container&) -> span<const typename _Container::value_type>;
563
Marshall Clow8dc3ea12018-07-24 03:56:38 +0000564#endif // _LIBCPP_STD_VER > 17
565
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000566_LIBCPP_END_NAMESPACE_STD
567
Arthur O'Dwyer518c1842020-11-27 14:13:05 -0500568_LIBCPP_POP_MACROS
569
Marshall Clowd2ad87e2018-07-24 03:01:02 +0000570#endif // _LIBCPP_SPAN